Versions Compared

Old Version 6

changes.mady.by.user Andrew Hill

Saved on

compared with

New Version Current

changes.mady.by.user Jason Andrew

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Tasks are never used standalone. They are always embedded within other objects that supports them.

The objects that currently support tasks are:


Panel
borderColorgrey
bgColorwhitesmoke

Related pages:


Task Object Formats

Include Page
_Task Object Formats
_Task Object Formats

Task Object Properties

(info) Required properties are in bold.

PropertyValueDescription
TaskIDstringThe unique task identifier. ServiceMobility only requires that the task identifier be unique within the collection of tasks for object it is contained in.
TaskTypestring

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

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

ActualStartdatetimeThe date and time, in UTC format, of when the task was started.
ActualEnddatetimeThe date and time, in UTC format, of when the task was completed.
DescstringAn optional detailed description of the task.
DurstringThe calculated duration the task took to complete. The format of the string is hh:mm where hh is hours and mm is minutes.
Extensionsobject
Include Page
_def_Extensions
_def_Extensions
FlexAttrsobject
Include Page
_def_FlexAttrs
_def_FlexAttrs
FlexFormscollection

Include Page
_def_FlexForms
_def_FlexForms

FlexFormsDisplayValuesobject

Include Page
_def_FlexFormsDisplayValues
_def_FlexFormsDisplayValues

Status
title4.14.0

FlexViewcollection

Include Page
_def_FlexViews
_def_FlexViews

Pausedboolean

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.
PriorityintegerSpecifies the priority of the task. Priorities range from 0-99.
NotescollectionA collection of notes related the task.
SchedDurdatetime(warning) This property has been deprecated. The mobile application will automatically calculate the estimated duration based o the SchedStart and SchedEnd properties.
SchedEnddatetimeThe date and time, in UTC format, of when the technician is scheduled to complete the task.
SchedStartdatetimeThe date and time, in UTC format, of when the technician is scheduled to start the task.
Statusstring

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
TitlestringThe 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