API reference (20230101)
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"){
"id": "<string>",
"externalId": "<string>",
"status": "IN_PROGRESS",
"taskType": "function",
"input": {
"function": {
"externalId": "my.known.id",
"data": {
"key1": "value1",
"key2": "value2"
}
},
"isAsyncComplete": false
},
"output": {
"callId": 123,
"functionId": 123,
"response": {}
},
"parentTaskExternalId": "<string>",
"startTime": 1730204346000,
"endTime": 1730204346000,
"reasonForIncompletion": "<string>"
}Update task status
Required capabilities:
workflowOrchestrationACL:WRITE
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 theretriesparameter for the task in the workflow definition.\FAILED_WITH_TERMINAL_ERROR: the task won’t be retried.
If anoutputis provided, it’ll be merged with the original output of the task.
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"){
"id": "<string>",
"externalId": "<string>",
"status": "IN_PROGRESS",
"taskType": "function",
"input": {
"function": {
"externalId": "my.known.id",
"data": {
"key1": "value1",
"key2": "value2"
}
},
"isAsyncComplete": false
},
"output": {
"callId": 123,
"functionId": 123,
"response": {}
},
"parentTaskExternalId": "<string>",
"startTime": 1730204346000,
"endTime": 1730204346000,
"reasonForIncompletion": "<string>"
}Authorizations
Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.
Path Parameters
UUIDv4 identifier for the execution of a workflow task.
36Body
COMPLETED, FAILED, FAILED_WITH_TERMINAL_ERROR 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.
{ "key1": "value1", "key2": "value2" }Response
Updated task
UUIDv4 identifier for the execution of a workflow task.
36Identifier for the task. Must be unique within the version. No trailing or leading whitespace and no null characters allowed. Task external IDs cannot be exactly 'workflow' or start with '__' (double underscore) as these are reserved.
255IN_PROGRESS, CANCELED, FAILED, FAILED_WITH_TERMINAL_ERROR, COMPLETED, COMPLETED_WITH_ERRORS, SCHEDULED, TIMED_OUT, SKIPPED function, transformation, cdf, dynamic, subworkflow, simulation The input to the task with the references present in the definition resolved.
- Function Task Parameters
- Transformation Task Parameters
- CDF Task Parameters
- Dynamic Task Parameters
- Option 5
Show child attributes
Show child attributes
- Function Task Output
- Transformation Task Output
- CDF Task Output
- Dynamic Task Output
- Simulator Task Output
Show child attributes
Show child attributes
The external ID of the parent task when this task is part of a dynamic task or subworkflow.
255The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
x >= 01730204346000
The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
x >= 01730204346000
Human-readable reason for terminal failure of a workflow task.
Was this page helpful?