Task Object Formats
| Include Page | ||||
|---|---|---|---|---|
|
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.
| ||||||
| 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 |
| ||||||
| FlexAttrs | object |
| ||||||
| FlexForms | collection |
| ||||||
| Paused | boolean | Identifies is the task is currently paused. Valid values are:
| ||||||
| 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:
| ||||||
| 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 |