res = client.workflows.executions.run("foo", "1")
client.workflows.executions.cancel(id="foo", reason="test cancellation"){
"id": "059edaa4-a17a-4102-910e-2c3591500cce",
"workflowExternalId": "<string>",
"status": "RUNNING",
"engineExecutionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdTime": 1730204346000,
"metadata": {},
"version": "<string>",
"startTime": 1730204346000,
"endTime": 1730204346000,
"reasonForIncompletion": "<string>"
}Cancel a workflow execution
Required capabilities:
workflowOrchestrationACL:WRITE
Stops the specified execution from starting new workflow tasks and sets the workflow execution status to TERMINATED. Already running tasks will be marked as CANCELED. Note that the actions taken by the canceled tasks won’t be stopped, and these need to be canceled separately if desired. For example, to cancel a running transformation, use the /transformations/cancel endpoint.
res = client.workflows.executions.run("foo", "1")
client.workflows.executions.cancel(id="foo", reason="test cancellation"){
"id": "059edaa4-a17a-4102-910e-2c3591500cce",
"workflowExternalId": "<string>",
"status": "RUNNING",
"engineExecutionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdTime": 1730204346000,
"metadata": {},
"version": "<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 a workflow execution.
36"059edaa4-a17a-4102-910e-2c3591500cce"
Body
Human-readable reason for the cancellation.
500Response
Updated workflow execution
UUIDv4 identifier for a workflow execution.
36"059edaa4-a17a-4102-910e-2c3591500cce"
Identifier for a workflow. Must be unique for the project. No trailing or leading whitespace and no null characters allowed.
255RUNNING, COMPLETED, FAILED, TIMED_OUT, TERMINATED Additional UUIDv4 identifier for an execution. Useful for Cognite support to diagnose issues.
36The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
x >= 01730204346000
Custom, application-specific metadata. String key -> String value. Keys have a maximum length of 32 characters, values a maximum of 255, and there can be a maximum of 10 key-value pairs.
Show child attributes
Show child attributes
Identifier for a version. Must be unique for the workflow. No trailing or leading whitespace and no null characters allowed.
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?