Process Instance

Get List Count

Queries for the number of process instances that fulfill given parameters.

get/process-instance/count

Request

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

Query parameters

processInstanceIdsstring

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

businessKeystring

Filter by process instance business key.

businessKeyLikestring

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

caseInstanceIdstring

Filter by case instance id.

processDefinitionIdstring

Filter by the deployment the id belongs to.

processDefinitionKeystring

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

processDefinitionKeyInstring

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

processDefinitionKeyNotInstring

Exclude instances by a comma-separated list of process definition keys. A process instance must not have one of the given process definition keys.

deploymentIdstring

Filter by the deployment the id belongs to.

superProcessInstancestring

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

subProcessInstancestring

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

superCaseInstancestring

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

subCaseInstancestring

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

activeboolean

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

suspendedboolean

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

withIncidentboolean

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

incidentIdstring

Filter by the incident id.

incidentTypestring

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

incidentMessagestring

Filter by the incident message. Exact match.

incidentMessageLikestring

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

tenantIdInstring

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

withoutTenantIdboolean

Only include process instances which belong to no tenant.

processDefinitionWithoutTenantIdboolean

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

activityIdInstring

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

rootProcessInstancesboolean

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

rootProcessInstanceIdstring

Filter by root process instance id.

leafProcessInstancesboolean

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

variablesstring

Only include process instances that have 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.

variableNamesIgnoreCaseboolean

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

variableValuesIgnoreCaseboolean

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

Response

Request successful.

countinteger

The number of matching instances.

Changes

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