Update status of async Task

async AsyncCogniteClient.workflows.tasks.update(
task_id: str,
status: Literal['completed', 'failed', 'failed_with_terminal_error'],
output: dict | None = None,
) → WorkflowTaskExecution

Update status of async task.

For tasks that has been marked with ‘is_async = True’, the status must be updated by calling this endpoint with either ‘completed’, ‘failed’ or ‘failed_with_terminal_error’.

Parameters:

  • task_id (str) – The server-generated id of the task.

  • status (Literal['completed', 'failed', 'failed_with_terminal_error']) – The new status of the task. Must be either ‘completed’, ‘failed’ or ‘failed_with_terminal_error’.

  • output (dict | None) – The output of the task. This will be available for tasks that has specified it as an output with the string “${<taskExternalId>.output}”

Returns:

The updated task execution.

Return type:

WorkflowTaskExecution

Examples

Update task with id ‘000560bc-9080-4286-b242-a27bb4819253’ to status ‘completed’:

>>> from cognite.client import CogniteClient, AsyncCogniteClient
>>> client = CogniteClient()
>>> # async_client = AsyncCogniteClient()  # another option
>>> res = client.workflows.tasks.update(
...     "000560bc-9080-4286-b242-a27bb4819253", "completed"
... )

Update task with id ‘000560bc-9080-4286-b242-a27bb4819253’ to status ‘failed’ with output ‘{“a”: 1, “b”: 2}’:

>>> res = client.workflows.tasks.update(
...     "000560bc-9080-4286-b242-a27bb4819253", "failed", output={"a": 1, "b": 2}
... )

Trigger workflow, retrieve detailed task execution and update status of the second task (assumed to be async) to ‘completed’:

>>> res = client.workflows.executions.run("my workflow", "1")
>>> res = client.workflows.executions.retrieve_detailed(res.id)
>>> res = client.workflows.tasks.update(res.tasks[1].id, "completed")