Skip to main content
PUT
/
process-definition
/
key
/
{key}
/
tenant-id
/
{tenant-id}
/
suspended
Activate/Suspend by Id
curl --request PUT \
  --url http://{host}:{port}/{contextPath}/process-definition/key/{key}/tenant-id/{tenant-id}/suspended \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "suspended": true,
  "includeProcessInstances": true,
  "executionDate": "2013-11-21T10:49:45T14:42:45"
}'
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.

Path Parameters

​
key
string
required

The key of the process definition (the latest version thereof) to be activated/suspended.

​
tenant-id
string
required

The id of the tenant the process definition belongs to.

Body

application/json

Note: Unallowed properties are processDefinitionId and processDefinitionKey.

​
suspended
boolean | null

A Boolean value which indicates whether to activate or suspend all process definitions with the given key. When the value is set to true, all process definitions with the given key will be suspended and when the value is set to false, all process definitions with the given key will be activated.

​
processDefinitionId
string | null

The id of the process definitions to activate or suspend.

​
processDefinitionKey
string | null

The key of the process definitions to activate or suspend.

​
includeProcessInstances
boolean | null

A Boolean value which indicates whether to activate or suspend also all process instances of the process definitions with the given key. When the value is set to true, all process instances of the process definitions with the given key will be activated or suspended and when the value is set to false, the suspension state of all process instances of the process definitions with the given key will not be updated.

​
executionDate
string<date-time> | null

The date on which all process definitions with the given key will be activated or suspended. If null, the suspension state of all process definitions with the given key is updated immediately. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200.

Response

Request successful.