Skip to main content
Version: 8.9 (unreleased)

Type Alias: GetProcessDefinitionStatisticsData

type GetProcessDefinitionStatisticsData = object;

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

Properties​

body?​

optional body: object;

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

Process definition element statistics request.

filter?​

optional filter: object & object;

Process definition statistics search filter.

Type Declaration​
batchOperationId?​
optional batchOperationId: StringFilterProperty;

The batch operation id.

elementId?​
optional elementId: StringFilterProperty;

The element id associated with the process instance.

elementInstanceState?​
optional elementInstanceState: ElementInstanceStateFilterProperty;

The state of the element instances associated with the process instance.

endDate?​
optional endDate: DateTimeFilterProperty;

The end date.

errorMessage?​
optional errorMessage: StringFilterProperty;

The error message related to the process.

hasElementInstanceIncident?​
optional hasElementInstanceIncident: boolean;

Whether the element instance has an incident or not.

hasIncident?​
optional hasIncident: boolean;

Whether this process instance has a related incident or not.

hasRetriesLeft?​
optional hasRetriesLeft: boolean;

Whether the process has failed jobs with retries left.

incidentErrorHashCode?​
optional incidentErrorHashCode: IntegerFilterProperty;

The incident error hash code, associated with this process.

parentElementInstanceKey?​
optional parentElementInstanceKey: ElementInstanceKeyFilterProperty;

The parent element instance key.

parentProcessInstanceKey?​
optional parentProcessInstanceKey: ProcessInstanceKeyFilterProperty;

The parent process instance key.

processInstanceKey?​
optional processInstanceKey: ProcessInstanceKeyFilterProperty;

The key of this process instance.

startDate?​
optional startDate: DateTimeFilterProperty;

The start date.

state?​
optional state: ProcessInstanceStateFilterProperty;

The process instance state.

tags?​
optional tags: TagSet;
tenantId?​
optional tenantId: StringFilterProperty;

The tenant id.

variables?​
optional variables: VariableValueFilterProperty[];

The process instance variables.

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

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.

path​

path: object;

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

processDefinitionKey​

processDefinitionKey: ProcessDefinitionKey;

The assigned key of the process definition, which acts as a unique identifier for this process definition.

query?​

optional query: never;

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

url​

url: "/process-definitions/{processDefinitionKey}/statistics/element-instances";

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