Authorization9

Batch7

Condition1

Decision Definition17

Decision Requirements Definition11

Deployment10

Engine1

Event Subscription2

Execution16

External Task18

Filter14

Group13

Historic Activity Instance5

Historic Batch7

Historic Decision Definition2

Historic Decision Instance5

Historic Decision Requirements Definition1

Historic Detail5

Historic External Task Log6

Historic Identity Link Log2

Historic Incident2

Historic Job Log6

Historic Process Definition3

Historic Process Instance10

Historic Task Instance5

Historic User Operation Log4

Historic Variable Instance7

History Cleanup4

Identity4

Incident6

Job15

Job Definition9

Message1

Metrics3

Migration4

Modification2

Process Definition46

Process Instance25

Process Instance Comment4

Schema Log2

Signal1

Task22

Task Attachment5

Task Comment6

Task Identity Link3

Task Local Variable7

Task Variable7

Telemetry3

Tenant14

User10

Variable Instance6

Version1

Historic Process Instance

Get List Count (POST)

Queries for the number of historic process instances that fulfill the given parameters. This method takes the same message body as the Get Process Instances (POST) method and therefore it is slightly more powerful than the Get Process Instance Count method.

post/history/process-instance/count

Request

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

Request body

processInstanceIdstring nullable

Filter by process instance id.

processInstanceIdsstring[] nullable

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

processInstanceIdNotInstring[] nullable

Exclude instances by process instance ids. Must be a JSON array of Strings.

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.

processDefinitionNamestring nullable

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

processDefinitionNameLikestring nullable

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

processDefinitionKeyNotInstring[] nullable

Exclude instances that belong to a set of process definitions. Must be a JSON array of Strings.

processInstanceBusinessKeystring nullable

Filter by process instance business key.

processInstanceBusinessKeyInstring[] nullable

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

processInstanceBusinessKeyLikestring nullable

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

rootProcessInstancesboolean nullable

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

rootProcessInstanceIdstring nullable

Filter by root process instance id.

finishedboolean nullable

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.

unfinishedboolean nullable

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

withJobsRetryingboolean nullable

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.

withIncidentsboolean nullable

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

withRootIncidentsboolean nullable

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

incidentIdInstring[] nullable

Restrict to instances that have an incident with one of the given ids. Must be a JSON array of Strings

incidentTypestring nullable

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

incidentStatus'open' | 'resolved' nullable

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

incidentMessagestring nullable

Filter by the incident message. Exact match.

incidentMessageLikestring nullable

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

startedBeforestring date-time nullable

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.

startedAfterstring date-time nullable

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.

finishedBeforestring date-time nullable

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.

finishedAfterstring date-time nullable

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.

executedActivityAfterstring date-time nullable

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.

executedActivityBeforestring date-time nullable

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.

executedJobAfterstring date-time nullable

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.

executedJobBeforestring date-time nullable

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.

startedBystring nullable

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

superProcessInstanceIdstring nullable

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

subProcessInstanceIdstring nullable

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

superCaseInstanceIdstring nullable

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

subCaseInstanceIdstring nullable

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

caseInstanceIdstring nullable

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

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 historic process instances which belong to no tenant. Value may only be true, as false is the default behavior.

activityIdInstring[] nullable

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. Must be a JSON array of Strings

executedActivityIdInstring[] nullable

Restrict to instances that executed an activity with one of given ids. Must be a JSON array of Strings

activeActivityIdInstring[] nullable

Restrict to instances that have an active activity with one of given ids. Must be a JSON array of Strings

activeboolean nullable

Restrict to instances that are active.

suspendedboolean nullable

Restrict to instances that are suspended.

completedboolean nullable

Restrict to instances that are completed.

externallyTerminatedboolean nullable

Restrict to instances that are externallyTerminated.

internallyTerminatedboolean nullable

Restrict to instances that are internallyTerminated.

variableNamesIgnoreCaseboolean nullable

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

variableValuesIgnoreCaseboolean nullable

Match all variable values provided in variables 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.