Interface SearchProcessInstanceRequest

This is the 8.8 API.

interface SearchProcessInstanceRequest {
    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?: SearchPageRequest;
    sort: {
        field: | "processDefinitionKey"
        | "processInstanceKey"
        | "parentFlowNodeInstanceKey"
        | "tenantId"
        | "state"
        | "processDefinitionVersion"
        | "processDefinitionId"
        | "processDefinitionName"
        | "processDefinitionVersionTag"
        | "parentProcessInstanceKey"
        | "startDate"
        | "endDate"
        | "hasIncident";
        order?: "ASC"
        | "DESC";
    }[];
}

Index

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

OptionalendDate?: string | AdvancedDateTimeFilter
The end date.
OptionalparentFlowNodeInstanceKey?: string | AdvancedStringFilter
The parent flow node instance key.
OptionalparentProcessInstanceKey?: string | AdvancedStringFilter
The parent process instance key.
OptionalprocessDefinitionId?: string | AdvancedStringFilter
The process definition ID.
OptionalprocessDefinitionKey?: string | AdvancedStringFilter
The process definition key.
OptionalprocessDefinitionName?: string | AdvancedStringFilter
The process definition name.
OptionalprocessDefinitionVersion?: string | AdvancedStringFilter
The process definition version.
OptionalprocessDefinitionVersionTag?: string | AdvancedStringFilter
The process definition version tag.
OptionalprocessInstanceKey?: string | AdvancedStringFilter
The key of this process instance.
OptionalstartDate?: string | AdvancedDateTimeFilter
The start date.
Optionalstate?: "ACTIVE" | "COMPLETED" | "TERMINATED"
The process instance state.
OptionaltenantId?: string | AdvancedStringFilter
The tenant ID.
Optionalvariables?: { name: string; value: string }[]
The process instance variables.

`Optional`page

page?: SearchPageRequest

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"
Optionalorder?: "ASC" | "DESC"
The order in which to sort the related field. Default value: ASC

Interface SearchProcessInstanceRequest

Index

Properties

Properties

filter

Type declaration

`Optional`endDate?: string | AdvancedDateTimeFilter

`Optional`parentFlowNodeInstanceKey?: string | AdvancedStringFilter

`Optional`parentProcessInstanceKey?: string | AdvancedStringFilter

`Optional`processDefinitionId?: string | AdvancedStringFilter

`Optional`processDefinitionKey?: string | AdvancedStringFilter

`Optional`processDefinitionName?: string | AdvancedStringFilter

`Optional`processDefinitionVersion?: string | AdvancedStringFilter

`Optional`processDefinitionVersionTag?: string | AdvancedStringFilter

`Optional`processInstanceKey?: string | AdvancedStringFilter

`Optional`startDate?: string | AdvancedDateTimeFilter

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

`Optional`tenantId?: string | AdvancedStringFilter

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

`Optional`page

sort

Type declaration

`Optional`order?: "ASC" | "DESC"

Settings

On This Page

Interface SearchProcessInstanceRequest

Index

Properties

Properties

filter

Type declaration

OptionalendDate?: string | AdvancedDateTimeFilter

OptionalparentFlowNodeInstanceKey?: string | AdvancedStringFilter

OptionalparentProcessInstanceKey?: string | AdvancedStringFilter

OptionalprocessDefinitionId?: string | AdvancedStringFilter

OptionalprocessDefinitionKey?: string | AdvancedStringFilter

OptionalprocessDefinitionName?: string | AdvancedStringFilter

OptionalprocessDefinitionVersion?: string | AdvancedStringFilter

OptionalprocessDefinitionVersionTag?: string | AdvancedStringFilter

OptionalprocessInstanceKey?: string | AdvancedStringFilter

OptionalstartDate?: string | AdvancedDateTimeFilter

Optionalstate?: "ACTIVE" | "COMPLETED" | "TERMINATED"

OptionaltenantId?: string | AdvancedStringFilter

Optionalvariables?: { name: string; value: string }[]

Optionalpage

sort

Type declaration

field: | "processDefinitionKey" | "processInstanceKey" | "parentFlowNodeInstanceKey" | "tenantId" | "state" | "processDefinitionVersion" | "processDefinitionId" | "processDefinitionName" | "processDefinitionVersionTag" | "parentProcessInstanceKey" | "startDate" | "endDate" | "hasIncident"

Optionalorder?: "ASC" | "DESC"

Settings

On This Page

`Optional`endDate?: string | AdvancedDateTimeFilter

`Optional`parentFlowNodeInstanceKey?: string | AdvancedStringFilter

`Optional`parentProcessInstanceKey?: string | AdvancedStringFilter

`Optional`processDefinitionId?: string | AdvancedStringFilter

`Optional`processDefinitionKey?: string | AdvancedStringFilter

`Optional`processDefinitionName?: string | AdvancedStringFilter

`Optional`processDefinitionVersion?: string | AdvancedStringFilter

`Optional`processDefinitionVersionTag?: string | AdvancedStringFilter

`Optional`processInstanceKey?: string | AdvancedStringFilter

`Optional`startDate?: string | AdvancedDateTimeFilter

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

`Optional`tenantId?: string | AdvancedStringFilter

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

`Optional`page

field:
| "processDefinitionKey"
| "processInstanceKey"
| "parentFlowNodeInstanceKey"
| "tenantId"
| "state"
| "processDefinitionVersion"
| "processDefinitionId"
| "processDefinitionName"
| "processDefinitionVersionTag"
| "parentProcessInstanceKey"
| "startDate"
| "endDate"
| "hasIncident"

`Optional`order?: "ASC" | "DESC"