Skip to main content
POST
/
process-instance
/
{id}
/
modification
Modify Process Instance Execution State
curl --request POST \
  --url http://{host}:{port}/{contextPath}/process-instance/{id}/modification \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "skipCustomListeners": true,
  "skipIoMappings": true,
  "instructions": [
    {
      "type": "startBeforeActivity",
      "activityId": "activityId",
      "variables": {
        "var": {
          "value": "aVariableValue",
          "local": false,
          "type": "String"
        },
        "varLocal": {
          "value": "anotherVariableValue",
          "local": true,
          "type": "String"
        }
      }
    },
    {
      "type": "cancel",
      "activityInstanceId": "anActivityInstanceId"
    }
  ],
  "annotation": "Modified to resolve an error."
}
'
{
  "type": "<string>",
  "message": "<string>",
  "code": 123
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

​
id
string
required

The id of the process instance to modify.

Body

application/json
​
skipCustomListeners
boolean | null

Skip execution listener invocation for activities that are started or ended as part of this request.

​
skipIoMappings
boolean | null

Skip execution of input/output variable mappings for activities that are started or ended as part of this request.

​
instructions
object[] | null

JSON array of modification instructions. The instructions are executed in the order they are in.

​
annotation
string | null

An arbitrary text annotation set by a user for auditing reasons.

Response

Request successful.