Request
This endpoint expects an object.
taskIdstringOptional
If non-empty, will set the requested Task ID, otherwise will generate a new random
GUID. Will reject if supplied Task ID does not match [A-Za-z0-9_-.]36.
descriptionstringOptional
Longer, free form human readable description of this Task.
specificationobjectOptional
The path for the Protobuf task definition, and the complete task data.
authorobjectOptional
A Principal is an entity that has authority over this task.
relationsobjectOptional
Any relationships associated with this Task, such as a parent Task or an assignee
this Task is designated to for execution.
isExecutedElsewherebooleanOptional
If set, then the service will not trigger execution of this task on an agent. Useful
for when ingesting tasks from an external system that is triggering execution of tasks
on agents.
initialEntitieslist of objectsOptional
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.
retryStrategyobjectOptional
Any retry strategy for task execution or update.
deliveryConstraintsobjectOptional
Describes scheduling constraints for Lattice when delivering the task to the agent.
executionConstraintsobjectOptional
Describes scheduling constraints for the agent executing the task after it has been delivered.
displayNamestringOptionalDeprecated
Human readable display name for this Task, should be short (<100 chars).
Response
Task creation 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.
