Process Instance

Get List (POST)

Queries for process instances that fulfill given parameters through a JSON object. This method is slightly more powerful than the Get Instances method because it allows filtering by multiple process variables of types string, number or boolean.

post/process-instance

Request

Base URL: http://localhost:8080/engine-rest
URL: http://localhost:8080/engine-rest/process-instance
Auth: HTTP basic

Query parameters

firstResultinteger

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

maxResultsinteger

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

Request body

deploymentIdstring nullable

Filter by the deployment the id belongs to.

processDefinitionIdstring nullable

Filter by the process definition the instances run on.

processDefinitionKeystring nullable

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

processDefinitionKeyInstring[] nullable

Filter by a list of process definition keys. A process instance must have one of the given process definition keys. Must be a JSON array of Strings.

processDefinitionKeyNotInstring[] nullable

Exclude instances by a list of process definition keys. A process instance must not have one of the given process definition keys. Must be a JSON array of Strings.

businessKeystring nullable

Filter by process instance business key.

businessKeyLikestring nullable

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

caseInstanceIdstring nullable

Filter by case instance id.

superProcessInstancestring nullable

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

subProcessInstancestring nullable

Restrict query to all process instances that have the given process instance as a sub process instance. Takes a process instance id.

superCaseInstancestring nullable

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

subCaseInstancestring nullable

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

activeboolean nullable

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

suspendedboolean nullable

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

processInstanceIdsstring[] nullable

Filter by a list of process instance ids. Must be a JSON array of Strings.

withIncidentboolean nullable

Filter by presence of incidents. Selects only process instances that have an incident.

incidentIdstring nullable

Filter by the incident id.

incidentTypestring nullable

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

incidentMessagestring nullable

Filter by the incident message. Exact match.

incidentMessageLikestring nullable

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

tenantIdInstring[] nullable

Filter by a list of tenant ids. A process instance must have one of the given tenant ids. Must be a JSON array of Strings.

withoutTenantIdboolean nullable

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

processDefinitionWithoutTenantIdboolean nullable

Only include process instances which process definition has no tenant id.

activityIdInstring[] nullable

Filter by a list of activity ids. A process instance must currently wait in a leaf activity with one of the given activity ids.

rootProcessInstancesboolean nullable

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

leafProcessInstancesboolean nullable

Restrict the query to all process instances that are leaf instances. (i.e. don't have any sub instances)

variableNamesIgnoreCaseboolean nullable

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

variableValuesIgnoreCaseboolean nullable

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

Response

Request successful.

idstring nullable

The id of the process instance.

definitionIdstring nullable

The id of the process definition that this process instance belongs to.

definitionKeystring nullable

The key of the process definition that this process instance belongs to.

businessKeystring nullable

The business key of the process instance.

caseInstanceIdstring nullable

The id of the case instance associated with the process instance.

endedboolean nullable

A flag indicating whether the process instance has ended or not. Deprecated: will always be false!

suspendedboolean nullable

A flag indicating whether the process instance is suspended or not.

tenantIdstring nullable

The tenant id of the process instance.

Changes

No recorded changes to this operation across all 1 revision of this API.