Cancel a workflow execution

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.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
path Parameters
executionId
required
string (WorkflowExecutionId) = 36 characters

UUIDv4 identifier for a workflow execution.

Example: 059edaa4-a17a-4102-910e-2c3591500cce
Request Body schema: application/json
optional
reason
string <= 500 characters
Default: "cancelled"

Human-readable reason for the cancellation.

Responses
200

Updated workflow execution

404

The response for a failed request.

post/workflows/executions/{executionId}/cancel
Request samples
application/json
{
  • "reason": "cancelled"
}
Response samples
application/json
{
  • "id": "059edaa4-a17a-4102-910e-2c3591500cce",
  • "workflowExternalId": "string",
  • "version": "string",
  • "status": "RUNNING",
  • "engineExecutionId": "stringstringstringstringstringstring",
  • "createdTime": 0,
  • "startTime": 0,
  • "endTime": 0,
  • "reasonForIncompletion": "string",
  • "metadata": {
    • "property1": "string",
    • "property2": "string"
    }
}
➔ Next to Filter workflow executions