@camunda8/sdk
    Preparing search index...

    Interface SearchProcessInstanceRequest

    This is the 8.8 API.

    interface SearchProcessInstanceRequest {
        filter: SearchProcessInstanceRequestFilter;
        page?: SearchPageRequest;
        sort?: SearchSortRequest<
            | "processDefinitionKey"
            | "processInstanceKey"
            | "parentFlowNodeInstanceKey"
            | "tenantId"
            | "state"
            | "processDefinitionVersion"
            | "processDefinitionId"
            | "processDefinitionName"
            | "processDefinitionVersionTag"
            | "parentProcessInstanceKey"
            | "startDate"
            | "endDate"
            | "hasIncident",
        >;
    }

    Hierarchy (View Summary)

    • BaseSearchRequest<
          | "processInstanceKey"
          | "processDefinitionId"
          | "processDefinitionName"
          | "processDefinitionVersion"
          | "processDefinitionVersionTag"
          | "processDefinitionKey"
          | "parentProcessInstanceKey"
          | "parentFlowNodeInstanceKey"
          | "state"
          | "startDate"
          | "endDate"
          | "tenantId"
          | "hasIncident",
          SearchProcessInstanceRequestFilter,
      >
      • SearchProcessInstanceRequest
    Index

    Properties

    filter page? sort?

    Properties

    filter: SearchProcessInstanceRequestFilter

    Search filter criteria.

    Optionalpage

    page?: SearchPageRequest

    Pagination criteria.

    sort?: SearchSortRequest<
        | "processDefinitionKey"
        | "processInstanceKey"
        | "parentFlowNodeInstanceKey"
        | "tenantId"
        | "state"
        | "processDefinitionVersion"
        | "processDefinitionId"
        | "processDefinitionName"
        | "processDefinitionVersionTag"
        | "parentProcessInstanceKey"
        | "startDate"
        | "endDate"
        | "hasIncident",
    >

    Sort field criteria.

    Settings

    Member Visibility

    On This Page

    Properties