Skip to main content
POST
/
execution
Get Executions (POST)
curl --request POST \
  --url http://{host}:{port}/{contextPath}/execution \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "variables": [
    {
      "name": "myVariable",
      "operator": "eq",
      "value": "camunda"
    },
    {
      "name": "mySecondVariable",
      "operator": "neq",
      "value": 124
    }
  ],
  "processDefinitionId": "aProcessDefinitionId",
  "sorting": [
    {
      "sortBy": "definitionKey",
      "sortOrder": "asc"
    },
    {
      "sortBy": "instanceId",
      "sortOrder": "desc"
    }
  ]
}'
[
  {
    "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

​
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.

Body

application/json

A Execution instance query which defines a list of Execution instances

​
businessKey
string | null

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

​
processDefinitionId
string | null

Filter by the process definition the executions run on.

​
processDefinitionKey
string | null

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

​
processInstanceId
string | null

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

​
activityId
string | null

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

​
signalEventSubscriptionName
string | null

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

​
messageEventSubscriptionName
string | null

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

​
active
boolean | null

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

​
suspended
boolean | null

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

​
incidentId
string | null

Filter by the incident id.

​
incidentType
string | null

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

​
incidentMessage
string | null

Filter by the incident message. Exact match.

​
incidentMessageLike
string | null

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

​
tenantIdIn
string[] | null

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

​
variables
object[] | null

An array to only include executions that have variables with certain values.

The array consists of objects with the three properties name, operator and value. name (String) is the variable name, operator (String) is the comparison operator to be used and value the variable value. value may be String, Number or Boolean.

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.

​
processVariables
object[] | null

An array to only include executions that belong to a process instance with variables with certain values.

The array consists of objects with the three properties name, operator and value. name (String) is the variable name, operator (String) is the comparison operator to be used and value the variable value. value may be String, Number or Boolean.

Valid operator values are: eq - equal to; neq - not equal to.

​
variableNamesIgnoreCase
boolean | null

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

​
variableValuesIgnoreCase
boolean | null

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

​
sorting
object[] | null

An array of criteria to sort the result by. Each element of the array is an object that specifies one ordering. The position in the array identifies the rank of an ordering, i.e., whether it is primary, secondary, etc. Has no effect for the /count endpoint

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.