For the complete documentation index, see llms.txt.
Skip to main content
Version: 8.10 (unreleased)

Cancel process instances (batch)Added in 8.8

POST 
/process-instances/cancellation

Strongly Consistent About endpoint data consistency

Cancels multiple active or suspended process instances. Only ACTIVE and SUSPENDED root instances can be cancelled. A state filter narrows the batch to the given states. Requesting any state other than ACTIVE or SUSPENDED through the $eq or $in operators is rejected. Other state operators ($neq, $exists, $like) are applied as given, and the batch remains limited to ACTIVE and SUSPENDED instances. Without a state filter, both ACTIVE and SUSPENDED instances are selected. Any given filter for parentProcessInstanceKey is ignored and overridden during this batch operation. This is done asynchronously, the progress can be tracked using the batchOperationKey from the response and the batch operation status endpoint (/batch-operations/{batchOperationKey}).

Required permissions​

When authorization is enabled, this endpoint requires the following permission. See resources and permissions to learn more.

Resource typePermission
BATCHCREATE or CREATE_BATCH_OPERATION_CANCEL_PROCESS_INSTANCE

Request​

Responses​

The batch operation request was created.