Update task status

Update the status of a task that is defined to be completed asynchronously (i.e. task parameter isAsyncComplete is set to true). The status can be set to COMPLETED, FAILED, or FAILED_WITH_TERMINAL_ERROR.

  • COMPLETED: the workflow execution will continue according to the workflow definition.\
  • FAILED: the task will be retried according to the retries parameter for the task in the workflow definition.\
  • FAILED_WITH_TERMINAL_ERROR: the task won't be retried.
    If an output is provided, it'll be merged with the original output of the task.
Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
path Parameters
taskId
required
string (TaskExecutionId) = 36 characters

UUIDv4 identifier for the execution of a workflow task.

Request Body schema: application/json
required
status
required
string
Enum: "COMPLETED" "FAILED" "FAILED_WITH_TERMINAL_ERROR"
output
object

Custom output data of the task, which will be merged with the original output of the task. The output data should be in JSON format, and is limited to 100KB in size.

Responses
200

Updated task

post/workflows/tasks/{taskId}/update
Request samples 
res = client.workflows.tasks.update("000560bc-9080-4286-b242-a27bb4819253", "completed")

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

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")
Response samples
application/json
{
  • "id": "stringstringstringstringstringstring",
  • "externalId": "string",
  • "status": "IN_PROGRESS",
  • "taskType": "function",
  • "startTime": 1730204346000,
  • "endTime": 1730204346000,
  • "input": {
    • "function": {
      },
    • "isAsyncComplete": false
    },
  • "output": {
    • "callId": 0,
    • "functionId": 0,
    • "response": { }
    },
  • "reasonForIncompletion": "string"
}
➔ Next to Simulators / Simulators