@camunda8/sdk
    Preparing search index...

    Interface ActivateInstructions

    interface ActivateInstructions {
        ancestorElementInstanceKey?: string;
        elementId: string;
        variableInstructions?: {
            scopeId?: string;
            variables: { [key: string]: null | string | number | boolean };
        }[];
    }
    Index

    Properties

    ancestorElementInstanceKey? elementId variableInstructions?

    Properties

    ancestorElementInstanceKey?: string

    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. Default: -1

    elementId: string

    The ID of the element that should be activated.

    variableInstructions?: {
        scopeId?: string;
        variables: { [key: string]: null | string | number | boolean };
    }[]

    Type declaration

    • OptionalscopeId?: 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 *

    • variables: { [key: string]: null | string | number | boolean }

      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.

    Settings

    Member Visibility

    On This Page

    Properties