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

    Type Alias CreateProcessInstanceResult

    type CreateProcessInstanceResult = {
        businessId?: BusinessId | null;
        processDefinitionId: ProcessDefinitionId;
        processDefinitionKey: ProcessDefinitionKey;
        processDefinitionVersion: number;
        processInstanceKey: ProcessInstanceKey;
        tags: TagSet;
        tenantId: TenantId;
        variables: { [key: string]: unknown };
    }
    Index

    Properties

    businessId? processDefinitionId processDefinitionKey processDefinitionVersion processInstanceKey tags tenantId variables

    Properties

    businessId?: BusinessId | null

    Business id as provided on creation.

    processDefinitionId: ProcessDefinitionId

    The BPMN process id of the process definition which was used to create the process. instance

    processDefinitionKey: ProcessDefinitionKey

    The key of the process definition which was used to create the process instance.

    processDefinitionVersion: number

    The version of the process definition which was used to create the process instance.

    processInstanceKey: ProcessInstanceKey

    The unique identifier of the created process instance; to be used wherever a request needs a process instance key (e.g. CancelProcessInstanceRequest).

    tags: TagSet
    tenantId: TenantId

    The tenant id of the created process instance.

    variables: { [key: string]: unknown }

    All the variables visible in the root scope.

    Settings

    Member Visibility

    On This Page

    Properties