Skip to main content
Version: 8.10 (unreleased)

Type Alias: BaseProcessInstanceFilterFields

type BaseProcessInstanceFilterFields = object;

Base process instance search filter.

Properties​

batchOperationId?​

optional batchOperationId?: StringFilterProperty;

The batch operation id. Deprecated: Use batchOperationKey instead. This field will be removed in a future release. If both batchOperationId and batchOperationKey are provided, the request will be rejected with a 400 error.

Deprecated​

batchOperationKey?​

optional batchOperationKey?: StringFilterProperty;

The batch operation key.

businessId?​

optional businessId?: StringFilterProperty;

The business id associated with the process instance.

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.