Handle External Task BPMN Error
Reports a business error in the context of a running external task by id. The error code must be specified to identify the BPMN error handler.
Method
POST /external-task/{id}/bpmnError
Parameters
Path Parameters
| Name | Description |
|---|---|
| id | The id of the external task in which context a BPMN error is reported. |
Request Body
A JSON object with the following properties:
| Name | Description |
|---|---|
| workerId | The id of the worker that reports the failure. Must match the id of the worker who has most recently locked the task. |
| errorCode | A error code that indicates the predefined error. Is used to identify the BPMN error handler. |
Result
This method returns no content.
Response Codes
| Code | Media type | Description |
|---|---|---|
| 204 | Request successful. | |
| 400 | application/json | Returned if the task's most recent lock was not acquired by the provided worker. See the Introduction for the error response format. |
| 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. |
| 500 | application/json | Returned if the corresponding process instance could not be resumed successfully. See the Introduction for the error response format. |
Example
Request
POST /external-task/anId/bpmnError
Request Body:
{
"workerId": "aWorker",
"errorCode": "bpmn-error"
}
Response
Status 204. No content.