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

    Type Alias ProcessInstanceCreationInstructionByKey

    Process creation by key

    type ProcessInstanceCreationInstructionByKey = {
        awaitCompletion?: boolean;
        businessId?: BusinessId;
        fetchVariables?: string[];
        operationReference?: OperationReference;
        processDefinitionKey: ProcessDefinitionKey;
        processDefinitionVersion?: number;
        requestTimeout?: number;
        runtimeInstructions?: ProcessInstanceCreationRuntimeInstruction[];
        startInstructions?: ProcessInstanceCreationStartInstruction[];
        tags?: TagSet;
        tenantId?: TenantId;
        variables?: { [key: string]: unknown };
    }
    Index

    Properties

    awaitCompletion? businessId? fetchVariables? operationReference? processDefinitionKey processDefinitionVersion? requestTimeout? runtimeInstructions? startInstructions? tags? tenantId? variables?

    Properties

    awaitCompletion?: boolean

    Wait for the process instance to complete. If the process instance does not complete within the request timeout limit, a 504 response status will be returned. The process instance will continue to run in the background regardless of the timeout. Disabled by default.

    businessId?: BusinessId
    fetchVariables?: string[]

    List of variables by name to be included in the response when awaitCompletion is set to true. If empty, all visible variables in the root scope will be returned.

    operationReference?: OperationReference
    processDefinitionKey: ProcessDefinitionKey

    The unique key identifying the process definition, for example, returned for a process in the deploy resources endpoint.

    processDefinitionVersion?: number

    As the version is already identified by the processDefinitionKey, the value of this field is ignored. It's here for backwards-compatibility only as previous releases accepted it in request bodies.

    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?: ProcessInstanceCreationStartInstruction[]

    List of start instructions. By default, the process instance will start at the start event. If provided, the process instance will apply start instructions after it has been created.

    tags?: TagSet
    tenantId?: TenantId

    The tenant id of the process definition. If multi-tenancy is enabled, provide the tenant id of the process definition to start a process instance of. If multi-tenancy is disabled, don't provide this parameter.

    variables?: { [key: string]: unknown }

    Set of variables as JSON object to instantiate in the root variable scope of the process instance. Can include nested complex objects.

    Settings

    Member Visibility

    On This Page

    Properties