@camunda8/orchestration-cluster-api
    Preparing search index...

    Type Alias ProcessInstanceModificationActivateInstruction

    Instruction describing an element to activate.

    type ProcessInstanceModificationActivateInstruction = {
        ancestorElementInstanceKey?: string | ElementInstanceKey;
        elementId: ElementId;
        variableInstructions?: ModifyProcessInstanceVariableInstruction[];
    }
    Index

    Properties

    ancestorElementInstanceKey? elementId variableInstructions?

    Properties

    ancestorElementInstanceKey?: string | ElementInstanceKey

    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. If multiple instances of the target element's flow scope exist, choose one specifically with this property by providing its key.

    elementId: ElementId

    The id of the element to activate.

    variableInstructions?: ModifyProcessInstanceVariableInstruction[]

    Instructions describing which variables to create or update.

    Settings

    Member Visibility

    On This Page

    Properties