Skip to main content
PUT
/
process-instance
/
suspended
curl --request PUT \
  --url http://{host}:{port}/{contextPath}/process-instance/suspended \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "processDefinitionId": "aProcDefId",
  "suspended": true
}'
This response does not have an example.

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json
​
processDefinitionId
string | null

The process definition id of the process instances to activate or suspend.

Note: This parameter can be used only with combination of suspended.

​
processDefinitionKey
string | null

The process definition key of the process instances to activate or suspend.

Note: This parameter can be used only with combination of suspended, processDefinitionTenantId, and processDefinitionWithoutTenantId.

​
processDefinitionTenantId
string | null

Only activate or suspend process instances of a process definition which belongs to a tenant with the given id.

Note: This parameter can be used only with combination of suspended, processDefinitionKey, and processDefinitionWithoutTenantId.

​
processDefinitionWithoutTenantId
boolean | null

Only activate or suspend process instances of a process definition which belongs to no tenant. Value may only be true, as false is the default behavior.

Note: This parameter can be used only with combination of suspended, processDefinitionKey, and processDefinitionTenantId.

​
processInstanceIds
string[] | null

A list of process instance ids which defines a group of process instances which will be activated or suspended by the operation.

Note: This parameter can be used only with combination of suspended, processInstanceQuery, and historicProcessInstanceQuery.

​
processInstanceQuery
object

A process instance query which defines a group of process instances

​
historicProcessInstanceQuery
object

A historic process instance query which defines a group of historic process instances

​
suspended
boolean | null

A Boolean value which indicates whether to activate or suspend a given instance (e.g. process instance, job, job definition, or batch). When the value is set to true, the given instance will be suspended and when the value is set to false, the given instance will be activated.

Response

Request successful.