Get List

Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter.

Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter.

Pagination of results. Specifies the index of the first result to return.

Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left.

Filter by process instance id.

Filter by process instance ids. Filter by a comma-separated list of Strings.

Exclude instances by process instance ids. Filter by a comma-separated list of Strings.

Filter by the process definition the instances run on.

Filter by the key of the process definition the instances run on.

Filter by a list of process definition keys. A process instance must have one of the given process definition keys. Filter by a comma-separated list of Strings.

Filter by the name of the process definition the instances run on.

Filter by process definition names that the parameter is a substring of.

Exclude instances that belong to a set of process definitions. Filter by a comma-separated list of Strings.

Filter by process instance business key.

Filter by a list of business keys. A process instance must have one of the given business keys. Filter by a comma-separated list of Strings

Filter by process instance business key that the parameter is a substring of.

Restrict the query to all process instances that are top level process instances.

Filter by root process instance id.

Only include finished process instances. This flag includes all process instances that are completed or terminated. Value may only be true, as false is the default behavior.

Only include unfinished process instances. Value may only be true, as false is the default behavior.

Only include process instances which are associated with jobs that have encountered exceptions and still have retries left. Value may only be true, as false is the default behavior.

Only include process instances which have an incident. Value may only be true, as false is the default behavior.

Only include process instances which have a root incident. Value may only be true, as false is the default behavior.

Restrict to instances that have an incident with one of the given ids. Filter by a comma-separated list of Strings

Filter by the incident type. See the User Guide for a list of incident types.

Only include process instances which have an incident in status either open or resolved. To get all process instances, use the query parameter withIncidents.

Filter by the incident message. Exact match.

Filter by the incident message that the parameter is a substring of.

Restrict to instances that were started before the given date. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200.

Restrict to instances that were started after the given date. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200.

Restrict to instances that were finished before the given date. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200.

Restrict to instances that were finished after the given date. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200.

Restrict to instances that executed an activity after the given date (inclusive). By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200.

Restrict to instances that executed an activity before the given date (inclusive). By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200.

Restrict to instances that executed an job after the given date (inclusive). By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200.

Restrict to instances that executed an job before the given date (inclusive). By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200.

Only include process instances that were started by the given user.

Restrict query to all process instances that are sub process instances of the given process instance. Takes a process instance id.

Restrict query to one process instance that has a sub process instance with the given id.

Restrict query to all process instances that are sub process instances of the given case instance. Takes a case instance id.

Restrict query to one process instance that has a sub case instance with the given id.

Restrict query to all process instances that are sub process instances of the given case instance. Takes a case instance id.

Filter by a list of tenant ids. A process instance must have one of the given tenant ids. Filter by a comma-separated list of Strings

Only include historic process instances which belong to no tenant. Value may only be true, as false is the default behavior.

Restrict to instances with an active activity with one of the given ids. In contrast to the activeActivityIdIn filter, it can query for async and incident activities. Filter by a comma-separated list of Strings

Restrict to instances that executed an activity with one of given ids. Filter by a comma-separated list of Strings

Restrict to instances that have an active activity with one of given ids. Filter by a comma-separated list of Strings

Restrict to instances that are active.

Restrict to instances that are suspended.

Restrict to instances that are completed.

Restrict to instances that are externallyTerminated.

Restrict to instances that are internallyTerminated.

Only include process instances that have/had variables with certain values. Variable filtering expressions are comma-separated and are structured as follows: A valid parameter value has the form key_operator_value. key is the variable name, operator is the comparison operator to be used and value the variable value.

Note: Values are always treated as String objects on server side.

Valid operator values are: eq - equal to; neq - not equal to; gt - greater than; gteq - greater than or equal to; lt - lower than; lteq - lower than or equal to; like.

Key and value may not contain underscore or comma characters.

Match all variable names provided in variables case-insensitively. If set to true variableName and variablename are treated as equal.

Match all variable values provided in variables case-insensitively. If set to true variableValue and variablevalue are treated as equal.