Skip to main content
GET
/
history
/
process-instance
/
count
Get List Count
curl --request GET \
  --url http://{host}:{port}/{contextPath}/history/process-instance/count \
  --header 'Authorization: Basic <encoded-value>'
{
  "count": 1
}

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Query Parameters

processInstanceId
string

Filter by process instance id.

processInstanceIds
string

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

processDefinitionId
string

Filter by the process definition the instances run on.

processDefinitionKey
string

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

processDefinitionKeyIn
string

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.

processDefinitionName
string

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

processDefinitionNameLike
string

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

processDefinitionKeyNotIn
string

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

processInstanceBusinessKey
string

Filter by process instance business key.

processInstanceBusinessKeyIn
string

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

processInstanceBusinessKeyLike
string

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

rootProcessInstances
boolean

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

finished
boolean

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.

unfinished
boolean

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

withIncidents
boolean

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

withRootIncidents
boolean

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

incidentIdIn
string

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

incidentType
string

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

incidentStatus
enum<string>

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

Available options:
open,
resolved
incidentMessage
string

Filter by the incident message. Exact match.

incidentMessageLike
string

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

startedBefore
string<date-time>

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.

startedAfter
string<date-time>

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.

finishedBefore
string<date-time>

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.

finishedAfter
string<date-time>

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.

executedActivityAfter
string<date-time>

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.

executedActivityBefore
string<date-time>

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.

executedJobAfter
string<date-time>

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.

executedJobBefore
string<date-time>

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.

startedBy
string

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

superProcessInstanceId
string

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

subProcessInstanceId
string

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

superCaseInstanceId
string

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

subCaseInstanceId
string

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

caseInstanceId
string

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

tenantIdIn
string

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

withoutTenantId
boolean

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

activityIdIn
string

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

executedActivityIdIn
string

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

activeActivityIdIn
string

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

active
boolean

Restrict to instances that are active.

suspended
boolean

Restrict to instances that are suspended.

completed
boolean

Restrict to instances that are completed.

externallyTerminated
boolean

Restrict to instances that are externallyTerminated.

internallyTerminated
boolean

Restrict to instances that are internallyTerminated.

variables
string

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.

variableNamesIgnoreCase
boolean

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

variableValuesIgnoreCase
boolean

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

Response

Request successful.

count
integer

The number of matching instances.