Cancel process instances (batch)Added in 8.8 Physical tenant

POST 
/process-instances/cancellation

Strongly Consistent About endpoint data consistency

Cancels multiple active or suspended process instances. Only ACTIVE and SUSPENDED root instances are cancelled; child instances are cancelled together with their root instance. The given filter only narrows the batch, so a filter on parentProcessInstanceKey matches no instances. Other state operators ($neq, $notIn, $exists, $like) are applied as given and are not validated. 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 type	Permission
BATCH	CREATE or CREATE_BATCH_OPERATION_CANCEL_PROCESS_INSTANCE

Request

Responses

200

The batch operation request was created.

400

The process instance batch operation failed, for example because the filter requests a top-level state other than ACTIVE or SUSPENDED through $eq or $in. States inside $or branches are not validated. More details are provided in the response body.

401

The request lacks valid authentication credentials.

Response Headers

WWW-Authenticate

403

Forbidden. The request is not allowed.

500

An internal error occurred while processing the request.