Sign in
Job Definition

Set Job Definition Priority by Id

Sets an overriding execution priority for jobs with the given definition id. Optionally, the priorities of all the definitions' 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.

put/job-definition/{id}/jobPriority

Request

  • Base URL: http://localhost:8080/engine-rest
  • URL: http://localhost:8080/engine-rest/job-definition/{id}/jobPriority
  • Auth: HTTP basic

Path parameters

idstring required

The id of the job definition to be updated.

Request body

priorityinteger nullable

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.

includeJobsboolean nullable

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.

Changes

No recorded changes to this operation across all 1 revision of this API.