Submits a list of modification instructions to change a process instance's execution state async. A modification instruction is one of the following:

• Starting execution before an activity
• Starting execution after an activity on its single outgoing sequence flow
• Starting execution on a specific sequence flow
• Cancelling an activity instance, transition instance, or all instances (activity or transition) for an activity
  Instructions are executed asynchronous and in the order they are provided in this request's body. Variables can be provided with every starting instruction.

The exact semantics of modification can be read about in the user guide.

Method

POST /process-instance/{id}/modification-async

Parameters

Path Parameters

Request Body

A JSON object with the following properties:

If there are multiple parent activity instances of the targeted activity, this specifies the ancestor scope in which hierarchy the activity/transition is to be instantiated.

Example: When there are two instances of a subprocess and an activity contained in the subprocess is to be started, this parameter allows to specify under which subprocess instance the activity should be started.

|type|Mandatory. One of the following values: cancel, startBeforeActivity, startAfterActivity, startTransition. A cancel instruction requests cancellation of a single activity instance or all instances of one activity. A startBeforeActivity instruction requests to enter a given activity. A startAfterActivity instruction requests to execute the single outgoing sequence flow of a given activity. A startTransition instruction requests to execute a specific sequence flow.
|activityId|Can be used with instructions of types startBeforeActivity, startAfterActivity, and cancel. Specifies the activity the instruction targets.
|transitionId|Can be used with instructions of types startTransition. Specifies the sequence flow to start.
|activityInstanceId|Can be used with instructions of type cancel. Specifies the activity instance to cancel. Valid values are the activity instance IDs supplied by the Get Activity Instance request.
|transitionInstanceId|Can be used with instructions of type cancel. Specifies the transition instance to cancel. Valid values are the transition instance IDs supplied by the Get Activity Instance request.
|ancestorActivityInstanceId|
Can be used with instructions of type startBeforeActivity, startAfterActivity, and startTransition. Valid values are the activity instance IDs supplied by the Get Activity Instance request.

If there are multiple parent activity instances of the targeted activity, this specifies the ancestor scope in which hierarchy the activity/transition is to be instantiated.

Example: When there are two instances of a subprocess and an activity contained in the subprocess is to be started, this parameter allows to specify under which subprocess instance the activity should be started.

Result

A JSON object corresponding to the Batch interface in the engine. Itsproperties are as follows:

Response Codes

Example

Request

POST /process-instance/aProcessInstanceId/modification-async

Request Body:

{
"skipCustomListeners": true,
"skipIoMappings": true,
"instructions": [
    {
      "type": "startBeforeActivity",
      "activityId": "activityId"
    },
    {
      "type": "cancel",
      "activityInstanceId": "anActivityInstanceId",
    }
  ]
}

Response

Status 200.

{
  "id": "aBatchId",
  "type": "instance-modification",
  "totalJobs": 10,
  "batchJobsPerSeed": 100,
  "invocationsPerBatchJob": 1,
  "seedJobDefinitionId": "aSeedJobDefinitionId",
  "monitorJobDefinitionId": "aMonitorJobDefinitionId",
  "batchJobDefinitionId": "aBatchJobDefinitionId",
  "tenantId": "aTenantId"
}

原文: https://docs.camunda.org/manual/7.9/reference/rest/process-instance/post-modification-async/