Skip to main content
Version: Next

Modify process instance

POST 
/process-instances/:processInstanceKey/modification

Modifies a running process instance. This request can contain multiple instructions to activate an element of the process or to terminate an active instance of an element.

Use this to repair a process instance that is stuck on an element or took an unintended path. For example, because an external system is not available or doesn't respond as expected.

Request​

Path Parameters

    processInstanceKey int64required

    The key of the process instance that should be modified.

Body

required
    activateInstructions object[]

    Instructions describing which elements should be activated in which scopes and which variables should be created.

  • Array [
    • elementId stringrequired

    The ID of the element that should be activated.

    ancestorElementInstanceKey int64

    Default value: -1

    The key of the ancestor scope the element instance should be created in. Set to -1 to create the new element instance within an existing element instance of the flow scope.

    variableInstructions object[]

    Instructions describing which variables should be created.

  • Array [
    • variables objectrequired

    JSON document that will instantiate the variables for the root variable scope of the process instance. It must be a JSON object, as variables will be mapped in a key-value fashion.

    property name* any

    Additional properties allowed.

    scopeId string

    The ID of the element in which scope the variables should be created. Leave empty to create the variables in the global scope of the process instance

  • ]
  • ]
    • terminateInstructions object[]

    Instructions describing which elements should be terminated.

  • Array [
    • elementInstanceKey int64required

    The ID of the element that should be terminated.

  • ]
    • operationReference int64

    Possible values: >= 1

    A reference key chosen by the user that will be part of all records resulting from this operation. Must be > 0 if provided.

Responses​

The process instance is modified.

Loading...