Skip to main content
Version: 8.9 (unreleased)

Type Alias: SearchProcessInstancesData

type SearchProcessInstancesData = object;

Defined in: gen/types.gen.ts:13623

Properties​

body?​

optional body: SearchQueryRequest & object;

Defined in: gen/types.gen.ts:13627

Process instance search request.

Type Declaration​

filter?​
optional filter: BaseProcessInstanceFilterFields & object & object;

Process instance search filter.

Type Declaration​
processDefinitionId?​
optional processDefinitionId: StringFilterProperty;

The process definition id.

processDefinitionKey?​
optional processDefinitionKey: ProcessDefinitionKeyFilterProperty;

The process definition key.

processDefinitionName?​
optional processDefinitionName: StringFilterProperty;

The process definition name.

processDefinitionVersion?​
optional processDefinitionVersion: IntegerFilterProperty;

The process definition version.

processDefinitionVersionTag?​
optional processDefinitionVersionTag: StringFilterProperty;

The process definition version tag.

Type Declaration​
$or?​
optional $or: BaseProcessInstanceFilterFields & object[];

Defines a list of alternative filter groups combined using OR logic. Each object in the array is evaluated independently, and the filter matches if any one of them is satisfied.

Top-level fields and the $or clause are combined using AND logic — meaning: (top-level filters) AND (any of the $or filters) must match.

Example:

{
  "state": "ACTIVE",
  "tenantId": 123,
  "$or": [
    { "processDefinitionId": "process_v1" },
    { "processDefinitionId": "process_v2", "hasIncident": true }
  ]
}

This matches process instances that:

  • are in ACTIVE state

  • have tenant id equal to 123

  • and match either:

  • processDefinitionId is process_v1, or

  • processDefinitionId is process_v2 and hasIncident is true

Note: Using complex $or conditions may impact performance, use with caution in high-volume environments.

sort?​
optional sort: object[];

Sort field criteria.

path?​

optional path: never;

Defined in: gen/types.gen.ts:13720

query?​

optional query: never;

Defined in: gen/types.gen.ts:13721

url​

url: "/process-instances/search";

Defined in: gen/types.gen.ts:13722