Sign in
Process Instance

Modify Process Instance Execution State

Submits a list of modification instructions to change a process instance's execution state. 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
  • Canceling an activity instance, transition instance, or all instances (activity or transition) for an activity

Instructions are executed immediately 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.

post/process-instance/{id}/modification

Request

  • Base URL: http://localhost:8080/engine-rest
  • URL: http://localhost:8080/engine-rest/process-instance/{id}/modification
  • Auth: HTTP basic

Path parameters

idstring required

The id of the process instance to modify.

Request body

skipCustomListenersboolean nullable

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

skipIoMappingsboolean nullable

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

annotationstring nullable

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

Response

Request successful.

Changes

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