Updates the status of a Task as it progresses through its lifecycle.
This method allows agents or operators to report the current state of a task,
which could include changes to task status, and error information.
Each status update increments the task’s status_version. When updating status,
clients must provide the current version to ensure consistency. The system rejects
updates with mismatched versions to prevent race conditions.
Terminal states (STATUS_DONE_OK and STATUS_DONE_NOT_OK) are permanent; once a task
reaches these states, no further updates are allowed.
Request
This endpoint expects an object.
statusVersionintegerOptional
The status version of the task to update. This version number increments to indicate the task's
current stage in its status lifecycle. Specifically, whenever a task's status updates, the status
version increments by one. Any status updates received with a lower status version number than what
is known are considered stale and ignored.
newStatusobjectOptional
The new status of the task.
authorobjectOptional
A Principal is an entity that has authority over this task.
Response
Task status update was successful
versionobjectOptional
Version of this task.
displayNamestringOptional
DEPRECATED: Human readable display name for this task, should be short (<100 chars).
specificationobjectOptional
The path for the Protobuf task definition, and the complete task data.
createdByobjectOptional
Records who created this task. This field will not change after the task has been created.
lastUpdatedByobjectOptional
Records who updated this task last.
lastUpdateTimedatetimeOptional
Records the time of last update.
statusobjectOptional
The status of this task.
scheduledTimedatetimeOptional
If the task has been scheduled to execute, what time it should execute at.
relationsobjectOptional
Any related Tasks associated with this, typically includes an assignee for this task and/or a parent.
descriptionstringOptional
Longer, free form human readable description of this task
isExecutedElsewherebooleanOptional
If set, execution of this task is managed elsewhere, not by Task Manager.
In other words, task manager will not attempt to update the assigned agent with execution instructions.
createTimedatetimeOptional
Time of task creation.
replicationobjectOptional
If populated, designates this to be a replicated task.
initialEntitieslist of objectsOptional
If populated, indicates an initial set of entities that can be used to execute an entity aware task
For example, an entity Objective, an entity Keep In Zone, etc.
These will not be updated during execution. If a taskable agent needs continuous updates on the entities from the
COP, can call entity-manager, or use an AlternateId escape hatch.
ownerobjectOptional
The networked owner of this task. It is used to ensure that linear writes occur on the node responsible
for replication of task data to other nodes running Task Manager.
retryStrategyobjectOptional
Sets an optional try strategy for tasks. Use this option to control how Lattice attempts to retry delivery of tasks to assets with intermittent access or network connectivity to your environment.
deliveryStateobjectOptional
The current delivery state of a task.
executionConstraintsobjectOptional
Any execution-related scheduling constraints for the agent after task delivery.
