v1

latestOpenAPI 3.1.02026-08-0420819698.7 KB
Routes
Tasks

Update Task

This request updates the top level information of a Task.

name | String | Optional | The name of the task. locationID | Int | Optional | The location to which the task is assigned. Must be the location's unique ID number. due | Int | Optional | The time at which the task is due for completion. Must be a unix timestamp. type | Int | Optional | The type of task according to this legend:, 1 = Preventative Maintanance (PM)., 2 = Unplanned Work Order (WO);, 4 = Planned Work Order (WO);, 6 = Work Request (WR)., Only these type of tasks can be changed from one task type to another. description | string | Optional | A brief description about the task. asset | Int | Optional | The asset that the task will be attached to, if any. Must be the unique ID number of the asset. Omitting this parameter or setting it to zero will not attach the task to any asset. assignment | Int or null | Optional | The user or team to which the task will be assigned. Must be the unique ID number of the user or team that exists at the specified location. Pass 0 or null to unassign the task. Required when assignmentType is set and status is 1 (close). Not applicable when assignmentType is 'multi'. assignmentType | Enum | Optional. Required if 'assignment' is used. | Specifies whether this task will be assigned to a 'user', 'team' or 'multi'. If this parameter is set, the assignment parameter must also be set. priority | Int | Optional | Specifies the priority of the task. Must be between 0 and 6 inclusive: 0 = lowest priority, 5 = highest priority, 6 = "On Hold". estimatedTime | Int | Optional | Updates the estimated time of the task. This is the time it takes to complete the task in minutes. scheduledStart | Int | Optional | The scheduled start date of the task. Must be a unix timestamp. Must be 0 or greater. scheduledEnd | Int | Optional | The scheduled end date of the task. Must be a unix timestamp. Must be 0 or greater. If both scheduledStart and scheduledEnd are provided, scheduledEnd must be greater than scheduledStart. requestName | string | Optional | Specifies the name of the work requestor. requestEmail | string | Optional | Specifies the email address of the work requestor. requestPhone | string | Optional | Specifies the phone number of the work requestor. requestDescription | string | Optional | Specifies the description set by the work requestor. status | int | Optional | 1 - Closes a task., 0 - Opens a task., If this parameter is set to 1, the assignment and assignmentType parameters must also be set. meta1 | string | Optional | Task meta data. This does not show in the web application, but can be used to track items between integrated systems. meta2 | string | Optional | Task meta data. This does not show in the web application, but can be used to track items between integrated systems. meta3 | string | Optional | Task meta data. This does not show in the web application, but can be used to track items between integrated systems. geoLocation | geoJSON | Optional | The geoJSON Feature object that can be used to locate a task on a Map. To remove geoLocation from a Task pass an empty object ({}). statusID | int | Optional | Update the custom status of the task. Cannot update custom status to 1 (Open) or 2 (Complete). multiUsers | array | Optional. Required if assignmentType = multi | Array of user IDs to assign to the task. Must contain at least one user for non-template tasks. Pass an empty array ([]) to remove all users from a PM template (unassign).

patch/v2/tasks/{taskID}

Response

The operation completed successfully. The response body is empty.