Skip to main content
PUT
/
job-definition
/
{id}
/
jobPriority
Set Job Definition Priority by Id
curl --request PUT \
  --url http://{host}:{port}/{contextPath}/job-definition/{id}/jobPriority \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "priority": 10,
  "includeJobs": true
}
'
{
  "type": "<string>",
  "message": "<string>",
  "code": 123
}

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 be updated.

Body

application/json
​
priority
integer<int64> | null

The new execution priority number for jobs of the given definition. The definition's priority can be reset by using the value null. In that case, the job definition's priority no longer applies but a new job's priority is determined as specified in the process model.

​
includeJobs
boolean | null

A boolean value indicating whether existing jobs of the given definition should receive the priority as well. Default value is false. Can only be true when the priority parameter is not null.

Response

Request successful. This method returns no content.