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

    Type Alias ProcessInstanceResult

    Process instance search response item.

    type ProcessInstanceResult = {
        businessId: BusinessId | null;
        endDate: string | null;
        hasIncident: boolean;
        parentElementInstanceKey: ElementInstanceKey | null;
        parentProcessInstanceKey: ProcessInstanceKey | null;
        processDefinitionId: ProcessDefinitionId;
        processDefinitionKey: ProcessDefinitionKey;
        processDefinitionName: string | null;
        processDefinitionVersion: number;
        processDefinitionVersionTag: string | null;
        processInstanceKey: ProcessInstanceKey;
        rootProcessInstanceKey: ProcessInstanceKey | null;
        startDate: string;
        state: ProcessInstanceStateEnum;
        tags: TagSet;
        tenantId: TenantId;
    }
    Index

    Properties

    businessId endDate hasIncident parentElementInstanceKey parentProcessInstanceKey processDefinitionId processDefinitionKey processDefinitionName processDefinitionVersion processDefinitionVersionTag processInstanceKey rootProcessInstanceKey startDate state tags tenantId

    Properties

    businessId: BusinessId | null

    The business id associated with this process instance.

    endDate: string | null

    The completion or termination time of the process instance.

    hasIncident: boolean

    Whether this process instance has a related incident or not.

    parentElementInstanceKey: ElementInstanceKey | null

    The parent element instance key.

    parentProcessInstanceKey: ProcessInstanceKey | null

    The parent process instance key.

    processDefinitionId: ProcessDefinitionId
    processDefinitionKey: ProcessDefinitionKey

    The process definition key.

    processDefinitionName: string | null

    The process definition name.

    processDefinitionVersion: number

    The process definition version.

    processDefinitionVersionTag: string | null

    The process definition version tag.

    processInstanceKey: ProcessInstanceKey

    The key of this process instance.

    rootProcessInstanceKey: ProcessInstanceKey | null

    The key of the root process instance. The root process instance is the top-level ancestor in the process instance hierarchy. This field is only present for data belonging to process instance hierarchies created in version 8.9 or later.

    startDate: string

    The start time of the process instance.

    state: ProcessInstanceStateEnum
    tags: TagSet
    tenantId: TenantId

    Settings

    Member Visibility

    On This Page

    Properties