Skip to main content
POST
/
modification
/
execute
Execute Modification
curl --request POST \
  --url http://{host}:{port}/{contextPath}/modification/execute \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "processDefinitionId": "aProcessDefinitionId",
  "instructions": [
    {
      "type": "startAfterActivity",
      "activityId": "aUserTask"
    },
    {
      "type": "cancel",
      "activityId": "anotherTask",
      "cancelCurrentActiveActivityInstances": true
    }
  ],
  "processInstanceIds": [
    "aProcessInstance",
    "anotherProcessInstance"
  ],
  "processInstanceQuery": {
    "processDefinitionId": "aProcessDefinitionId"
  },
  "skipCustomListeners": true,
  "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.

Body

application/json
​
processDefinitionId
string | null

The id of the process definition for the modification

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

​
processInstanceIds
string[] | null

A list of process instance ids to modify.

​
processInstanceQuery
object

A process instance query which defines a group of process instances

​
historicProcessInstanceQuery
object

A historic process instance query which defines a group of historic process instances

​
instructions
object[] | null

An 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. This method returns no content.