Sign in
Execution

Get Executions (POST)

Queries for executions that fulfill given parameters through a JSON object. This method is slightly more powerful than the Get Executions method because it allows to filter by multiple instance and execution variables of types String, Number or Boolean.

post/execution

Request

  • Base URL: http://localhost:8080/engine-rest
  • URL: http://localhost:8080/engine-rest/execution
  • 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

businessKeystring nullable

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

processDefinitionIdstring nullable

Filter by the process definition the executions run on.

processDefinitionKeystring nullable

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

processInstanceIdstring nullable

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

activityIdstring nullable

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

signalEventSubscriptionNamestring nullable

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

messageEventSubscriptionNamestring nullable

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

activeboolean nullable

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

suspendedboolean nullable

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

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

variableNamesIgnoreCaseboolean nullable

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

variableValuesIgnoreCaseboolean nullable

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.

idstring nullable

The id of the Execution.

processInstanceIdstring nullable

The id of the root of the execution tree representing the process instance.

endedboolean nullable

Indicates if the execution is ended.

tenantIdstring nullable

The id of the tenant this execution belongs to. Can be null if the execution belongs to no single tenant.

Changes

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