Skip to main content
PUT
/
job-definition
/
{id}
/
suspended
Activate/Suspend Job Definition By Id
curl --request PUT \
  --url http://{host}:{port}/{contextPath}/job-definition/{id}/suspended \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "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.

Path Parameters

​
id
string
required

The id of the job definition to activate or suspend.

Body

application/json
​
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.