Set External Task Priority

Set the priority of an existing external task. The default value of a priority is 0.

Method

PUT /external-task/{id}/priority

Parameters

Path Parameters

Name Description
id The id of the external task to set the priority for.

Request Body

A JSON object with the following properties:

Name Description
priority The priority of the external task.

Result

This method returns no content.

Response Codes

Code Media type Description
204 Request successful.
404 application/json Returned if the task does not exist. This could indicate a wrong task id as well as a cancelled task, e.g., due to a caught BPMN boundary event. See the Introduction for the error response format.

Example

Request

PUT /external-task/{anId}/priority

Request Body:

{
  "priority": 5
}

Response

Status 204. No content.

On this Page: