REST Object Definitions Work Order Activity Related Objects Task Object

Task Object Formats

JSON Format

{
  "TaskID": "",
  "TaskType": "",
  "ActualStart": "",
  "ActualEnd": "",
  "Desc": "",
  "Dur": "",
  "Extensions": {
    "key": "value1"
  },
  "FlexAttrs": {
    "${FlexFormID}": {
      "${FlexAttrID}": [
        "",
        ""
      ]
    }
  },
  "FlexForms": [
    "${FlexFormID}"
  ],
  "FlexFormsDisplayValues": [{
     "FlexFormID": "${FlexFormID}",
     "Title": "",
         "FlexGroups": [{
             "Title": "",
             "FlexAttrs": [{
                 "FlexAttrID": "${FlexAttrID}",
                  "Label": "label text",
                  "Value": "value text"
             }]
         }]
    }],
  "FlexView": [
    {
      "Title": "GroupName",
      "Items": [
        {
          "Label": "labeltext",
          "Value": "value text"
        }
      ]
    }
  ],
  "Paused": false,
  "Priority": 1,
  "Notes": [
    {
       "ID": "",
       "Author": "",
       "Date": "",
       "ReadOnly": true,
       "Text": "",
       "Delete": true
    }
  ],
  "SchedDur": "",
  "SchedEnd": "",
  "SchedStart": "",
  "Status": "",
  "Title": ""
}

Task Object Properties

Required properties are in bold.

Property Value Description

TaskID string The unique task identifier. ServiceMobility only requires that the task identifier be unique within the collection of tasks for object it is contained in.

TaskType

string

Identifies the type of task. The task types are maintained by the Task Types system category.

Starting with release 3.16.0, this field is no longer required.

ActualStart datetime The date and time, in UTC format, of when the task was started.

ActualEnd datetime The date and time, in UTC format, of when the task was completed.

Desc string An optional detailed description of the task.

Dur string The calculated duration the task took to complete. The format of the string is hh:mm where hh is hours and mm is minutes.

Extensions

object

This object contains an optional collection of key/value pairs.

These key/value are defined and controlled by the customer and are typically used to assist in integration by pass additional data around the system.

FlexAttrs

object

This property contains the FlexAttr values that were entered.

FlexAttrs are always associated with a FlexForm
FlexAttrs values can be pre-populated from the backend

Property

Type

Description

${FlexFormID}

object

Identifies the FlexForm

Property	Type	Description
${FlexAttrID}	array	Contains an collection of values entered for the FlexAttr field identified by ${FlexAttrID}.

FlexForms

collection

An optional collection of FlexForm IDs. Each form specified in the collection will be available for the identified task.

See: FlexForm Object

Paused

boolean

Identifies is the task is currently paused.

Valid values are:

true - Task is currently paused.
false - Task is currently not paused. This is the default value if this property is missing.

Priority integer Specifies the priority of the task. Priorities range from 0-99.

Notes collection A collection of notes related the task.

SchedDur datetime This property has been deprecated. The mobile application will automatically calculate the estimated duration based o the SchedStart and SchedEnd properties.

SchedEnd datetime The date and time, in UTC format, of when the technician is scheduled to complete the task.

SchedStart datetime The date and time, in UTC format, of when the technician is scheduled to start the task.

Status

string

Specifies the current status of the task. The status code descriptions are maintained by the Task Status Codes system category.

Valid values are:

1001 - Not started
1002 - In progress
1003 - Completed

Title string The title for the task. The title should be a short description. For a complete description of the task use the Desc property.

Delete

boolean

Optional property.

This property is used during a PATCH request to remove specific items. This property will never be returned during a GET request.

3.19.1