@camunda8/sdk
    Preparing search index...

    Interface CreateProcessInstanceFromProcessDefinitionId<V>

    interface CreateProcessInstanceFromProcessDefinitionId<
        V extends JSONDoc
        | LosslessDto,
    > {
        operationReference?: number | LosslessNumber;
        processDefinitionId: string;
        processDefinitionVersion?: number;
        requestTimeout?: number;
        runtimeInstructions?: ProcessInstanceCreationRuntimeInstruction[];
        startInstructions?: CamundaRestApiTypes.ProcessInstanceCreationStartInstruction[];
        tenantId?: string;
        variables: V;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

    operationReference? processDefinitionId processDefinitionVersion? requestTimeout? runtimeInstructions? startInstructions? tenantId? variables

    Properties

    operationReference?: number | LosslessNumber

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

    processDefinitionId: string

    the BPMN process ID of the process definition

    processDefinitionVersion?: number

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

    requestTimeout?: number

    Timeout (in ms) the request waits for the process to complete. By default or when set to 0, the generic request timeout configured in the cluster is applied.

    runtimeInstructions?: ProcessInstanceCreationRuntimeInstruction[]

    Runtime instructions (alpha). List of instructions that affect the runtime behavior of the process instance. Refer to specific instruction types for more details. This parameter is an alpha feature and may be subject to change in future releases.

    startInstructions?: CamundaRestApiTypes.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.

    Settings

    Member Visibility

    On This Page

    Properties