Execution

Get Execution Count

Queries for the number of executions that fulfill given parameters. Takes the same parameters as the Get Executions method.

get/execution/count

Request

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

Query parameters

businessKeystring

Filter by the business key of the process instances the executions belong to.

processDefinitionIdstring

Filter by the process definition the executions run on.

processDefinitionKeystring

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

processInstanceIdstring

Filter by the id of the process instance the execution belongs to.

activityIdstring

Filter by the id of the activity the execution currently executes.

signalEventSubscriptionNamestring

Select only those executions that expect a signal of the given name.

messageEventSubscriptionNamestring

Select only those executions that expect a message of the given name.

activeboolean

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

suspendedboolean

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

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. An execution must have one of the given tenant ids.

variablesstring

Only include executions 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.

processVariablesstring

Only include executions that belong to a process instance with 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. key and value may not contain underscore or comma characters.

variableNamesIgnoreCaseboolean

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

variableValuesIgnoreCaseboolean

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