LIlimblecmms
Routes
Tasks

Update Task

Changed on

This request updates the top level information of a Task.

ParameterTypeRequiredDescription
nameStringOptionalThe name of the task.
locationIDIntOptionalThe location to which the task is assigned. Must be the location's unique ID number.
dueIntOptionalThe time at which the task is due for completion. Must be a unix timestamp.
typeIntOptionalThe 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.
descriptionstringOptionalA brief description about the task.
assetIntOptionalThe 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.
assignmentInt or nullOptionalThe 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'.
assignmentTypeEnumOptional. 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.
priorityIntOptionalSpecifies the priority of the task. Must be between 0 and 6 inclusive: 0 = lowest priority, 5 = highest priority, 6 = "On Hold".
estimatedTimeIntOptionalUpdates the estimated time of the task. This is the time it takes to complete the task in minutes.
scheduledStartIntOptionalThe scheduled start date of the task. Must be a unix timestamp. Must be 0 or greater.
scheduledEndIntOptionalThe 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.
requestNamestringOptionalSpecifies the name of the work requestor.
requestEmailstringOptionalSpecifies the email address of the work requestor.
requestPhonestringOptionalSpecifies the phone number of the work requestor.
requestDescriptionstringOptionalSpecifies the description set by the work requestor.
statusintOptional1 - Closes a task., 0 - Opens a task., If this parameter is set to 1, the assignment and assignmentType parameters must also be set., A Task can only be closed once every Instruction on it is finished. Closing a Task that still has an unfinished Instruction returns a 422 identifying the Instruction.
meta1stringOptionalTask meta data. This does not show in the web application, but can be used to track items between integrated systems.
meta2stringOptionalTask meta data. This does not show in the web application, but can be used to track items between integrated systems.
meta3stringOptionalTask meta data. This does not show in the web application, but can be used to track items between integrated systems.
geoLocationgeoJSONOptionalThe geoJSON Feature object that can be used to locate a task on a Map. To remove geoLocation from a Task pass an empty object ({}).
statusIDintOptionalUpdate the custom status of the task. Cannot update custom status to 1 (Open) or 2 (Complete).
multiUsersarrayOptional. Required if assignmentType = multiArray 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}

Request

Response

The operation completed successfully. The response body is empty.

Changes