@camunda8/sdk
    Preparing search index...

    Interface CreateProcessInstanceReq<V>

    interface CreateProcessInstanceReq<V extends JSONDoc> {
        bpmnProcessId: string;
        operationReference?: number | LosslessNumber;
        startInstructions?: ProcessInstanceCreationStartInstruction[];
        tenantId?: string;
        variables: V;
        version?: number;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

    bpmnProcessId operationReference? startInstructions? tenantId? variables version?

    Properties

    bpmnProcessId: string

    The BPMN process ID of the process definition

    operationReference?: number | LosslessNumber

    A reference key chosen by the user and will be part of all records resulted from this operation

    startInstructions?: ProcessInstanceCreationStartInstruction[]

    List of start instructions. If empty (default) the process instance will start at the start event. If non-empty the process instance will apply start instructions after it has been created

    tenantId?: string

    The tenantId for a multi-tenant enabled cluster.

    variables: V

    JSON document that will instantiate the variables for the root variable scope of the process instance.

    version?: number

    The version of the process; if not specified it will use the latest version

    Settings

    Member Visibility

    On This Page

    Properties