@camunda8/sdk
    Preparing search index...

    Interface CreateProcessInstanceWithResultReq<T>

    interface CreateProcessInstanceWithResultReq<T extends JSONDoc> {
        bpmnProcessId: string;
        fetchVariables?: string[];
        operationReference?: number | LosslessNumber;
        requestTimeout?: number;
        tenantId?: string;
        variables: T;
        version?: number;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

    bpmnProcessId fetchVariables? operationReference? requestTimeout? tenantId? variables version?

    Properties

    bpmnProcessId: string

    The BPMN process ID of the process definition

    fetchVariables?: string[]

    List of names of variables to be included in CreateProcessInstanceWithResultResponse.variables. If empty, all visible variables in the root scope will be returned.

    operationReference?: number | LosslessNumber

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

    requestTimeout?: number

    Timeout in milliseconds. the request will be closed if the process is not completed before the requestTimeout. if requestTimeout = 0, uses the generic requestTimeout configured in the gateway.

    tenantId?: string

    The tenantId for a multi-tenant enabled cluster.

    variables: T

    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