Suspend process instances (batch)Added in 8.10 Physical tenant

POST 
/process-instances/suspension

Strongly Consistent About endpoint data consistency

Suspends multiple running process instances. Only ACTIVE process instances are suspended. The given filter only narrows the batch. Other state operators ($neq, $notIn, $exists, $like) are applied as given and are not validated. Suspension does not cascade, so child instances are suspended independently of their parent or root instance. 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_SUSPEND_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 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.