Edit on Github

Handle Task BPMN Escalation

Reports an escalation in the context of a running task by id. The escalation code must be specified to identify the escalation handler. See the documentation for Reporting Bpmn Escalation in User Tasks.

Method

POST /task/{id}/bpmnEscalation

Parameters

Path Parameters

Name Description
id The id of the task in which context a BPMN escalation is reported.

Request Body

A JSON object with the following properties:

Name Description
escalationCode An escalation code that indicates the predefined escalation. It is used to identify the BPMN escalation handler.
variables A JSON object containing the variables which will be passed to the execution. Each key corresponds to a variable name and each value to a variable value. A variable value is a JSON object with the following properties:

Name Description
value The variable's value. For variables of type Object, the serialized value has to be submitted as a String value.

For variables of type File the value has to be submitted as Base64 encoded string.

type The value type of the variable.
valueInfo A JSON object containing additional, value-type-dependent properties.

For serialized variables of type Object, the following properties can be provided:

  • objectTypeName: A string representation of the object's type name.
  • serializationDataFormat: The serialization format used to store the variable.

For serialized variables of type File, the following properties can be provided:

  • filename: The name of the file. This is not the variable name but the name that will be used when downloading the file again.
  • mimetype: The MIME type of the file that is being uploaded.
  • encoding: The encoding of the file that is being uploaded.

The following property can be provided for all value types:

  • transient: Indicates whether the variable should be transient or not. See documentation for more informations.

Result

This method returns no content.

Response Codes

Code Media type Description
204 Request successful.
400 application/json Returned if the escalationCode is not provided in the request. See the Introduction for the error response format.
403 application/json If the authenticated user is unauthorized to update the process instance. See the Introduction for the error response format.
404 application/json Returned if the task does not exist. See the Introduction for the error response format.

Example

Request

POST /task/aTaskId/bpmnEscalation

Request Body:

    {
      "escalationCode": "bpmn-escalation-432",
      "variables": {
          "aVariable" : {
              "value" : "aStringValue",
              "type": "String"
          },
          "anotherVariable" : {
              "value" : true,
              "type": "Boolean"
          }
      }
    }

Response

Status 204. No content.

On this Page: