@camunda8/sdk
    Preparing search index...

    Interface SearchElementInstancesRequest

    interface SearchElementInstancesRequest {
        filter: {
            elementId?: string;
            elementInstanceKey?: string;
            elementName?: string;
            hasIncident?: boolean;
            incidentKey?: string;
            processDefinitionId?: string;
            processDefinitionKey?: string;
            processInstanceKey?: string;
            state?: "ACTIVE" | "COMPLETED" | "TERMINATED";
            tenantId?: string;
            type?:
                | "UNKNOWN"
                | "UNSPECIFIED"
                | "PROCESS"
                | "SUB_PROCESS"
                | "EVENT_SUB_PROCESS"
                | "START_EVENT"
                | "INTERMEDIATE_CATCH_EVENT"
                | "INTERMEDIATE_THROW_EVENT"
                | "BOUNDARY_EVENT"
                | "END_EVENT"
                | "SERVICE_TASK"
                | "RECEIVE_TASK"
                | "USER_TASK"
                | "MANUAL_TASK"
                | "TASK"
                | "EXCLUSIVE_GATEWAY"
                | "INCLUSIVE_GATEWAY"
                | "PARALLEL_GATEWAY"
                | "EVENT_BASED_GATEWAY"
                | "SEQUENCE_FLOW"
                | "MULTI_INSTANCE_BODY"
                | "CALL_ACTIVITY"
                | "BUSINESS_RULE_TASK"
                | "SCRIPT_TASK"
                | "SEND_TASK"
                | "AD_HOC_SUB_PROCESS";
        };
        page?: SearchPageRequest;
        sort: {
            field: | "type"
            | "processDefinitionKey"
            | "processInstanceKey"
            | "incidentKey"
            | "tenantId"
            | "state"
            | "elementId"
            | "elementInstanceKey"
            | "processDefinitionId"
            | "startDate"
            | "endDate";
            order?: "ASC"
            | "DESC";
        }[];
    }
    Index

    Properties

    Properties

    filter: {
        elementId?: string;
        elementInstanceKey?: string;
        elementName?: string;
        hasIncident?: boolean;
        incidentKey?: string;
        processDefinitionId?: string;
        processDefinitionKey?: string;
        processInstanceKey?: string;
        state?: "ACTIVE" | "COMPLETED" | "TERMINATED";
        tenantId?: string;
        type?:
            | "UNKNOWN"
            | "UNSPECIFIED"
            | "PROCESS"
            | "SUB_PROCESS"
            | "EVENT_SUB_PROCESS"
            | "START_EVENT"
            | "INTERMEDIATE_CATCH_EVENT"
            | "INTERMEDIATE_THROW_EVENT"
            | "BOUNDARY_EVENT"
            | "END_EVENT"
            | "SERVICE_TASK"
            | "RECEIVE_TASK"
            | "USER_TASK"
            | "MANUAL_TASK"
            | "TASK"
            | "EXCLUSIVE_GATEWAY"
            | "INCLUSIVE_GATEWAY"
            | "PARALLEL_GATEWAY"
            | "EVENT_BASED_GATEWAY"
            | "SEQUENCE_FLOW"
            | "MULTI_INSTANCE_BODY"
            | "CALL_ACTIVITY"
            | "BUSINESS_RULE_TASK"
            | "SCRIPT_TASK"
            | "SEND_TASK"
            | "AD_HOC_SUB_PROCESS";
    }
    sort: {
        field:
            | "type"
            | "processDefinitionKey"
            | "processInstanceKey"
            | "incidentKey"
            | "tenantId"
            | "state"
            | "elementId"
            | "elementInstanceKey"
            | "processDefinitionId"
            | "startDate"
            | "endDate";
        order?: "ASC"
        | "DESC";
    }[]

    Type declaration

    • field:
          | "type"
          | "processDefinitionKey"
          | "processInstanceKey"
          | "incidentKey"
          | "tenantId"
          | "state"
          | "elementId"
          | "elementInstanceKey"
          | "processDefinitionId"
          | "startDate"
          | "endDate"

      The field to sort by.

    • Optionalorder?: "ASC" | "DESC"

      Default: ASC