Interface ModifyProcessInstanceRequest

interface ModifyProcessInstanceRequest {
    activateInstructions?: ActivateInstructions[];
    operationReference?: number | LosslessNumber;
    processInstanceKey: string;
    terminateInstructions?: { elementInstanceKey: string }[];
}

Index

Properties

activateInstructions? operationReference? processInstanceKey terminateInstructions?

Properties

`Optional`activateInstructions

activateInstructions?: ActivateInstructions[]

`Optional`operationReference

operationReference?: number | LosslessNumber

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

processInstanceKey

processInstanceKey: string

The key of the process instance to modify.

`Optional`terminateInstructions

terminateInstructions?: { elementInstanceKey: string }[]

Type declaration

elementInstanceKey: string
The ID of the element that should be terminated.