Type Alias ModifyProcessInstanceData

type ModifyProcessInstanceData = {
    body: {
        activateInstructions?: {
            ancestorElementInstanceKey?: string | ElementInstanceKey;
            elementId: ElementId;
            variableInstructions?: ModifyProcessInstanceVariableInstruction[];
        }[];
        moveInstructions?: {
            ancestorScopeInstruction?: AncestorScopeInstruction;
            sourceElementInstruction: | {
                sourceElementId: ElementId;
                sourceType: string;
            }
            | { sourceType: "byKey" } & SourceElementInstanceKeyInstruction;
            targetElementId: ElementId;
            variableInstructions?: ModifyProcessInstanceVariableInstruction[];
        }[];
        operationReference?: OperationReference;
        terminateInstructions?: (
            | { elementId: ElementId }
            | ProcessInstanceModificationTerminateByKeyInstruction
        )[];
    };
    path: { processInstanceKey: ProcessInstanceKey };
    query?: never;
    url: "/process-instances/{processInstanceKey}/modification";
}

Index

Properties

body path query? url

Properties

body

body: {
    activateInstructions?: {
        ancestorElementInstanceKey?: string | ElementInstanceKey;
        elementId: ElementId;
        variableInstructions?: ModifyProcessInstanceVariableInstruction[];
    }[];
    moveInstructions?: {
        ancestorScopeInstruction?: AncestorScopeInstruction;
        sourceElementInstruction: | {
            sourceElementId: ElementId;
            sourceType: string;
        }
        | { sourceType: "byKey" } & SourceElementInstanceKeyInstruction;
        targetElementId: ElementId;
        variableInstructions?: ModifyProcessInstanceVariableInstruction[];
    }[];
    operationReference?: OperationReference;
    terminateInstructions?: (
        | { elementId: ElementId }
        | ProcessInstanceModificationTerminateByKeyInstruction
    )[];
}

Type Declaration

OptionalactivateInstructions?: {
    ancestorElementInstanceKey?: string | ElementInstanceKey;
    elementId: ElementId;
    variableInstructions?: ModifyProcessInstanceVariableInstruction[];
}[]
Instructions describing which elements to activate in which scopes and which variables to create or update.
OptionalmoveInstructions?: {
    ancestorScopeInstruction?: AncestorScopeInstruction;
    sourceElementInstruction:
        | { sourceElementId: ElementId; sourceType: string }
        | { sourceType: "byKey" } & SourceElementInstanceKeyInstruction;
    targetElementId: ElementId;
    variableInstructions?: ModifyProcessInstanceVariableInstruction[];
}[]
Instructions describing which elements to move from one scope to another.
OptionaloperationReference?: OperationReference
OptionalterminateInstructions?: (
| { elementId: ElementId }
| ProcessInstanceModificationTerminateByKeyInstruction
)[]
Instruction describing which elements to terminate.

path

path: { processInstanceKey: ProcessInstanceKey }

Type Declaration

processInstanceKey: ProcessInstanceKey
The key of the process instance that should be modified.

`Optional`query

query?: never

url

url: "/process-instances/{processInstanceKey}/modification"

Type Alias ModifyProcessInstanceData

Index

Properties

Properties

body

Type Declaration

`Optional`activateInstructions?: {
    ancestorElementInstanceKey?: string | ElementInstanceKey;
    elementId: ElementId;
    variableInstructions?: ModifyProcessInstanceVariableInstruction[];
}[]

`Optional`operationReference?: OperationReference

`Optional`terminateInstructions?: (
| { elementId: ElementId }
| ProcessInstanceModificationTerminateByKeyInstruction
)[]

path

Type Declaration

processInstanceKey: ProcessInstanceKey

`Optional`query

url

Settings

On This Page

Type Alias ModifyProcessInstanceData

Index

Properties

Properties

body

Type Declaration

OptionalactivateInstructions?: { ancestorElementInstanceKey?: string | ElementInstanceKey; elementId: ElementId; variableInstructions?: ModifyProcessInstanceVariableInstruction[];}[]

OptionaloperationReference?: OperationReference

OptionalterminateInstructions?: ( | { elementId: ElementId } | ProcessInstanceModificationTerminateByKeyInstruction)[]

path

Type Declaration

processInstanceKey: ProcessInstanceKey

Optionalquery

url

Settings

On This Page

`Optional`activateInstructions?: {
ancestorElementInstanceKey?: string | ElementInstanceKey;
elementId: ElementId;
variableInstructions?: ModifyProcessInstanceVariableInstruction[];
}[]

`Optional`operationReference?: OperationReference

`Optional`terminateInstructions?: (
| { elementId: ElementId }
| ProcessInstanceModificationTerminateByKeyInstruction
)[]

`Optional`query