@camunda8/sdk
    Preparing search index...

    Interface SearchElementInstancesRequest

    Generic search request interface that can be used for most search operations

    interface SearchElementInstancesRequest {
        filter: ElementInstanceSearchRequestFilter;
        page?: SearchPageRequest;
        sort?: SearchSortRequest<
            | "type"
            | "processDefinitionKey"
            | "processInstanceKey"
            | "incidentKey"
            | "tenantId"
            | "state"
            | "elementId"
            | "elementInstanceKey"
            | "processDefinitionId"
            | "startDate"
            | "endDate",
        >;
    }

    Hierarchy (View Summary)

    • BaseSearchRequest<
          | "elementInstanceKey"
          | "processInstanceKey"
          | "processDefinitionKey"
          | "processDefinitionId"
          | "startDate"
          | "endDate"
          | "elementId"
          | "type"
          | "state"
          | "incidentKey"
          | "tenantId",
          ElementInstanceSearchRequestFilter,
      >
      • SearchElementInstancesRequest
    Index

    Properties

    filter page? sort?

    Properties

    filter: ElementInstanceSearchRequestFilter

    Search filter criteria.

    Optionalpage

    page?: SearchPageRequest

    Pagination criteria.

    sort?: SearchSortRequest<
        | "type"
        | "processDefinitionKey"
        | "processInstanceKey"
        | "incidentKey"
        | "tenantId"
        | "state"
        | "elementId"
        | "elementInstanceKey"
        | "processDefinitionId"
        | "startDate"
        | "endDate",
    >

    Sort field criteria.

    Settings

    Member Visibility

    On This Page

    Properties