Interface QueryProcessInstanceRequest

This is the 8.8 API.

interface QueryProcessInstanceRequest {
    filter: {
        endDate?: string | AdvancedDateTimeFilter;
        parentFlowNodeInstanceKey?: string | AdvancedStringFilter;
        parentProcessInstanceKey?: string | AdvancedStringFilter;
        processDefinitionId?: string | AdvancedStringFilter;
        processDefinitionKey?: string | AdvancedStringFilter;
        processDefinitionName?: string | AdvancedStringFilter;
        processDefinitionVersion?: string | AdvancedStringFilter;
        processDefinitionVersionTag?: string | AdvancedStringFilter;
        processInstanceKey?: string | AdvancedStringFilter;
        startDate?: string | AdvancedDateTimeFilter;
        state?: "ACTIVE" | "COMPLETED" | "TERMINATED";
        tenantId?: string | AdvancedStringFilter;
        variables?: {
            name: string;
            value: string;
        }[];
    };
    page?: QueryPageRequest;
    sort: {
        field: "processDefinitionKey" | "processInstanceKey" | "parentFlowNodeInstanceKey" | "tenantId" | "state" | "processDefinitionVersion" | "processDefinitionId" | "processDefinitionName" | "processDefinitionVersionTag" | "parentProcessInstanceKey" | "startDate" | "endDate" | "hasIncident";
        order?: "ASC" | "DESC";
    }[];
}

Properties

filter page? sort

Properties

filter

filter: {
    endDate?: string | AdvancedDateTimeFilter;
    parentFlowNodeInstanceKey?: string | AdvancedStringFilter;
    parentProcessInstanceKey?: string | AdvancedStringFilter;
    processDefinitionId?: string | AdvancedStringFilter;
    processDefinitionKey?: string | AdvancedStringFilter;
    processDefinitionName?: string | AdvancedStringFilter;
    processDefinitionVersion?: string | AdvancedStringFilter;
    processDefinitionVersionTag?: string | AdvancedStringFilter;
    processInstanceKey?: string | AdvancedStringFilter;
    startDate?: string | AdvancedDateTimeFilter;
    state?: "ACTIVE" | "COMPLETED" | "TERMINATED";
    tenantId?: string | AdvancedStringFilter;
    variables?: {
        name: string;
        value: string;
    }[];
}

Process instance search filter.

Type declaration

  • Optional endDate?: string | AdvancedDateTimeFilter

    The end date.

  • Optional parentFlowNodeInstanceKey?: string | AdvancedStringFilter

    The parent flow node instance key.

  • Optional parentProcessInstanceKey?: string | AdvancedStringFilter

    The parent process instance key.

  • Optional processDefinitionId?: string | AdvancedStringFilter

    The process definition ID.

  • Optional processDefinitionKey?: string | AdvancedStringFilter

    The process definition key.

  • Optional processDefinitionName?: string | AdvancedStringFilter

    The process definition name.

  • Optional processDefinitionVersion?: string | AdvancedStringFilter

    The process definition version.

  • Optional processDefinitionVersionTag?: string | AdvancedStringFilter

    The process definition version tag.

  • Optional processInstanceKey?: string | AdvancedStringFilter

    The key of this process instance.

  • Optional startDate?: string | AdvancedDateTimeFilter

    The start date.

  • Optional state?: "ACTIVE" | "COMPLETED" | "TERMINATED"

    The process instance state.

  • Optional tenantId?: string | AdvancedStringFilter

    The tenant ID.

  • Optional variables?: {
        name: string;
        value: string;
    }[]

    The process instance variables.

Optional page

page?: QueryPageRequest

Pagination criteria.

sort

sort: {
    field: "processDefinitionKey" | "processInstanceKey" | "parentFlowNodeInstanceKey" | "tenantId" | "state" | "processDefinitionVersion" | "processDefinitionId" | "processDefinitionName" | "processDefinitionVersionTag" | "parentProcessInstanceKey" | "startDate" | "endDate" | "hasIncident";
    order?: "ASC" | "DESC";
}[]

Sort field criteria.

Type declaration

  • field: "processDefinitionKey" | "processInstanceKey" | "parentFlowNodeInstanceKey" | "tenantId" | "state" | "processDefinitionVersion" | "processDefinitionId" | "processDefinitionName" | "processDefinitionVersionTag" | "parentProcessInstanceKey" | "startDate" | "endDate" | "hasIncident"
  • Optional order?: "ASC" | "DESC"

    The order in which to sort the related field. Default value: ASC

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc