Set Job Definition Priority by Id

Set an overriding execution priority for jobs with the given definition id. Optionally, the priorities of all the definition’s existing jobs are updated accordingly. The priority can be reset by setting it to null, meaning that a new job’s priority will not be determined based on its definition’s priority any longer. See the user guide on job prioritization for details.

Method

PUT /job-definition/{id}/jobPriority

Parameters

Path Parameters

Name Description
id The id of the job definition to be updated.

Request Body

A JSON object with the following properties:

Name Description
priority 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 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.

Result

This method returns no content.

Response Codes

Code Media type Description
204 Request successful.
404 application/json Job definition with given id does not exist. See the Introduction for the error response format.
500 application/json The retries could not be set successfully. See the Introduction for the error response format.

Example

Request

PUT /job-definition/aJobDefId/jobPriority

Request Body:

{
  "priority": 10,
  "includeJobs": true
}

Response

Status 204. No content.

On this Page: