Set External Task Retries
Sets the number of retries left to execute an external task by id. If retries are set to 0, an incident is created.
Method
PUT /external-task/{id}/retries
Parameters
Path Parameters
| Name | Description |
|---|---|
| id | The id of the external task to set the number of retries for. |
Request Body
A JSON object with the following properties:
| Name | Description |
|---|---|
| retries | The number of retries to set for the external task. Must be >= 0. If this is 0, an incident is created and the task cannot be fetched anymore unless the retries are increased again. Can not be null. |
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. |
| 400 | application/json | In case the number of retries is negative or null, an exception of type InvalidRequestException is returned. See the Introduction for the error response format. |
Example
Request
PUT /external-task/anId/retries
Request Body:
{
"retries": 123
}
Response
Status 204. No content.