Cancel execution

Use this information to cancel a currently running execution. Any steps currently executing might still complete, but future steps will be canceled.

The following elements are described:

Request

Aspect Value
Endpoint URL /api/behaviour/executions/{executionId}/cancel
HTTP Method POST

Path parameters

Field Description Mandatory
executionId ID of the execution Yes

Response

Aspect Value
Content-Type application/json
Response Code 202 (Accepted)

Body

Field Description
success True, if the execution was canceled. False, is returned only if the execution had already completed; thus it could not be canceled.