Skip to main content
PUT
/
job-definition
/
suspended
curl --request PUT \
  --url http://{host}:{port}/{contextPath}/job-definition/suspended \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "processDefinitionId": "aProcessDefinitionId",
  "suspended": true,
  "includeJobs": true,
  "executionDate": "2013-11-21T10:49:45.000+0200"
}'
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

Defines by which selection criterion to activate or suspend job definitions. The selection criteria are mutually exclusive and can only be one of:

  • processDefinitionId
  • processDefinitionKey
​
processDefinitionId
string | null

The process definition id of the job definitions to activate or suspend.

​
processDefinitionKey
string | null

The process definition key of the job definitions to activate or suspend.

​
processDefinitionTenantId
string | null

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

Note that this parameter will only be considered in combination with processDefinitionKey.

​
processDefinitionWithoutTenantId
boolean | null

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

Note that this parameter will only be considered in combination with processDefinitionKey.

​
includeJobs
boolean | null

A Boolean value which indicates whether to activate or suspend also all jobs of the referenced job definitions. When the value is set to true, all jobs of the provided job definitions will be activated or suspended and when the value is set to false, the suspension state of all jobs of the provided job definitions will not be updated.

​
executionDate
string | null

The date on which the referenced job definitions will be activated or suspended. If null, the suspension state of the given job definitions 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.

​
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. This method returns no content.