Skip to main content
Version: 8.9 (unreleased)

Type Alias: ProcessInstanceFilter

type ProcessInstanceFilter = ProcessInstanceFilterFields & object;

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

Process instance search filter.

Type Declaration

$or?

optional $or: ProcessInstanceFilterFields[];

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.