Skip to main content
GET
/
execution
Get Executions
curl --request GET \
  --url http://{host}:{port}/{contextPath}/execution \
  --header 'Authorization: Basic <encoded-value>'
[
  {
    "id": "anId",
    "processInstanceId": "aProcInstId",
    "ended": false,
    "tenantId": null
  }
]

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

businessKey
string

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

processDefinitionId
string

Filter by the process definition the executions run on.

processDefinitionKey
string

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

processInstanceId
string

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

activityId
string

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

signalEventSubscriptionName
string

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

messageEventSubscriptionName
string

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

active
boolean

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

suspended
boolean

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

incidentId
string

Filter by the incident id.

incidentType
string

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

incidentMessage
string

Filter by the incident message. Exact match.

incidentMessageLike
string

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

tenantIdIn
string

Filter by a comma-separated list of tenant ids. An execution must have one of the given tenant ids.

variables
string

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.

processVariables
string

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.

variableNamesIgnoreCase
boolean

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

variableValuesIgnoreCase
boolean

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

sortBy
enum<string>

Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter.

Available options:
instanceId,
definitionKey,
definitionId,
tenantId
sortOrder
enum<string>

Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter.

Available options:
asc,
desc
firstResult
integer

Pagination of results. Specifies the index of the first result to return.

maxResults
integer

Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left.

Response

Request successful.

id
string | null

The id of the Execution.

processInstanceId
string | null

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

ended
boolean | null

Indicates if the execution is ended.

tenantId
string | null

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