Sign in
External Task

Handle 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.

post/external-task/{id}/bpmnError

Request

  • Base URL: http://localhost:8080/engine-rest
  • URL: http://localhost:8080/engine-rest/external-task/{id}/bpmnError
  • Auth: HTTP basic

Path parameters

idstring required

The id of the external task in which context a BPMN error is reported.

Request body

workerIdstring nullable

The id of the worker that reports the failure. Must match the id of the worker who has most recently locked the task.

errorCodestring nullable

An error code that indicates the predefined error. It is used to identify the BPMN error handler.

errorMessagestring nullable

An error message that describes the error.

variablesobject nullable

A JSON object containing variable key-value pairs.

Response

Request successful.

Changes

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