REST Object Definitions Work Order Activity Related Objects Activity Object

An activity is a scheduled event that may or may not be associated with an actual address. Activities appear within the mobile application's schedule views along side scheduled work orders.

Any time the mobile user performs an action that causes the activity object to change, it will automatically be uploaded to the server. For example, when the activity is started, the activity object will be uploaded to the server with the updated Started field populated.

Related pages:

Activity Object Formats

JSON Format

{
    "ActivityID": "", 
    "Started": "", 
    "Ended": "", 
    "Address": {
        "City": "", 
        "Country": "", 
        "Line1": "", 
        "Line2": "", 
        "Name": "", 
        "State": "", 
        "Zip": ""
    }, 
    "Desc": "", 
    "Dur": "", 
    "Extensions": {
        "key1": "value1", 
        "key2": "value2"
    },  
    "FlexForms": [
        "${FlexFormID}"
    ],
    "FlexView": [
        {
            "Title": "GroupName",
            "Items": [
                {
                    "Label": "labeltext",
                    "Value": "valuetext"
                }
            ]
        }
    ],
    "Paused": false, 
    "Priority": "", 
    "Remarks": "",
    "SchedDur": "", 
    "SchedEnd": "", 
    "SchedStart": "", 
    "Status": "", 
    "SysActCode": "", 
    "Title": "", 
    "UserName": ""
}

Activity Object Properties

Required properties are in bold.

Property	Type	Description
ActivityID	string	The unique identifier for the activity. This value must be globally unique across all activities.
Description	string	A simple description of the activity.
Dur	integer	The duration, in seconds, on how long the activity took to complete. This property is being deprecated. You can calculate the actual duration based on the `Started` and `Ended` values.
Ended	datetime	The actual end date and time of when the activity was completed.
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	Flex attributes for activities will be implemented in a future release.
Paused	boolean	Identifies is the activity is currently paused. Valid values are: `true` = The activity is currently paused. `false` = The activity is not paused.
Priority	string	Identifies the current priority of the activity. See: Activity Priorities
RefCode	string	Identifies the primary key of a record this activity record is associated with. The meaning of the `RefCode` is identified by the `RefType` field.
RefType	string	If this activity record is associated (linked) with another object (e.g. a work order) then this field identifies the type of object it is linked to and the RefCode property identifies the actual object ID. Valid values are: `0 or null` - The activity is not associated with any other object in the system. `1001` - The activity is associated with a work order. The `RefCode` property will contain the work order number that it is associated with. `1002` - The activity is associated with an account. The `RefCode` property will contains the account number that it is associated with.
Remarks	collection	A collection of remarks made on the activity.
SchedDur	integer	This field has been deprecated.
SchedEndTime	datetime	The date and time, in UTC format, when the activity is scheduled to end.
SchedStartTime	datetime	The date and time, in UTC format, when the activity is scheduled to start.
Started	datetime	The date and time, in UTC format, when the activity was started.
Status	string	Identifies the current status of the activity.
SysActCode	string	Identifies the type of activity. Activity types are defined and controlled with a system category.
Title	string	A short title for the activity.