Skip to main content
PUT
/
job
/
suspended
curl --request PUT \
  --url http://{host}:{port}/{contextPath}/job/suspended \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "jobDefinitionId": "aJobDefinitionId",
  "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

Defines by which selection criterion to activate or suspend jobs. This selection criterion are mutually exclusive and can only be on of:

  • jobDefinitionId
  • processDefinitionId
  • processInstanceId
  • processDefinitionKey
​
jobDefinitionId
string | null

The job definition id of the jobs to activate or suspend.

​
processDefinitionId
string | null

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

​
processInstanceId
string | null

The process instance id of the jobs to activate or suspend.

​
processDefinitionKey
string | null

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

​
processDefinitionTenantId
string | null

Only activate or suspend jobs of a process definition which belongs to a tenant with the given id. Works only when selecting with processDefinitionKey.

​
processDefinitionWithoutTenantId
boolean | null

Only activate or suspend jobs of a process definition which belongs to no tenant. Value may only be true, as false is the default behavior. Works only when selecting with processDefinitionKey.

​
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.