Cancel task
Cancels a task by marking it for cancellation in the system.
This method initiates task cancellation based on the task’s current state:
- If the task has not been sent to an agent, it cancels immediately and transitions the task
to a terminal state (
STATUS_DONE_NOT_OKwithERROR_CODE_CANCELLED). - If the task has already been sent to an agent, the cancellation request is routed to the agent.
The agent is then responsible for deciding whether cancellation is possible or not:
- If the task can be cancelled, the agent must use
UpdateTaskStatusand set the task status toSTATUS_DONE_NOT_OK. - If the task cannot be cancelled, the agent must use
UpdateTaskStatusto attach aTaskErrorto the task with the error codeERROR_CODE_REJECTEDand amessageexplaining why the task cannot be cancelled.
- If the task can be cancelled, the agent must use
Authentication
AuthorizationBearer
Bearer authentication of the form Bearer <token>, where token is your auth token.
Path parameters
taskId
The ID of task to cancel
Request
This endpoint expects an object.
Response
Task cancellation was successful.
version
Version of this task.
displayName
DEPRECATED: Human readable display name for this task, should be short (<100 chars).
specification
The path for the Protobuf task definition, and the complete task data.
createdBy
Records who created this task. This field will not change after the task has been created.
lastUpdatedBy
Records who updated this task last.
lastUpdateTime
Records the time of last update.
status
The status of this task.
scheduledTime
If the task has been scheduled to execute, what time it should execute at.
relations
Any related Tasks associated with this, typically includes an assignee for this task and/or a parent.
description
Longer, free form human readable description of this task
isExecutedElsewhere
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.
createTime
Time of task creation.
replication
If populated, designates this to be a replicated task.
initialEntities
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.
owner
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.
retryStrategy
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.
deliveryState
The current delivery state of a task.
Errors
400
Bad Request Error
401
Unauthorized Error
404
Not Found Error