Skip to main content
POST
/
process-instance
Get List (POST)
curl --request POST \
  --url http://{host}:{port}/{contextPath}/process-instance \
  --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"
    }
  ]
}'
[
  {
    "links": [],
    "id": "anId",
    "definitionId": "aProcessDefinitionId",
    "businessKey": "aKey",
    "caseInstanceId": "aCaseInstanceId",
    "ended": false,
    "suspended": 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 process instance query which defines a group of process instances

​
deploymentId
string | null

Filter by the deployment the id belongs to.

​
processDefinitionId
string | null

Filter by the process definition the instances run on.

​
processDefinitionKey
string | null

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

​
processDefinitionKeyIn
string[] | null

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.

​
processDefinitionKeyNotIn
string[] | null

Exclude instances by a list of process definition keys. A process instance must not have one of the given process definition keys. Must be a JSON array of Strings.

​
businessKey
string | null

Filter by process instance business key.

​
businessKeyLike
string | null

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

​
caseInstanceId
string | null

Filter by case instance id.

​
superProcessInstance
string | null

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

​
subProcessInstance
string | null

Restrict query to all process instances that have the given process instance as a sub process instance. Takes a process instance id.

​
superCaseInstance
string | null

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

​
subCaseInstance
string | null

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

​
active
boolean | null

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

​
suspended
boolean | null

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

​
processInstanceIds
string[] | null

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

​
withIncident
boolean | null

Filter by presence of incidents. Selects only process instances that have an incident.

​
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. A process instance must have one of the given tenant ids. Must be a JSON array of Strings.

​
withoutTenantId
boolean | null

Only include process instances which belong to no tenant. Value may only be true, as false is the default behavior.

​
processDefinitionWithoutTenantId
boolean | null

Only include process instances which process definition has no tenant id.

​
activityIdIn
string[] | null

Filter by a list of activity ids. A process instance must currently wait in a leaf activity with one of the given activity ids.

​
rootProcessInstances
boolean | null

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

​
leafProcessInstances
boolean | null

Restrict the query to all process instances that are leaf instances. (i.e. don't have any sub instances)

​
variables
object[] | null

A JSON array to only include process instances 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. The 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.

​
variableNamesIgnoreCase
boolean | null

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

​
variableValuesIgnoreCase
boolean | null

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

​
orQueries
object[] | null

A JSON array of nested process instance queries with OR semantics. A process instance matches a nested query if it fulfills at least one of the query's predicates. With multiple nested queries, a process instance must fulfill at least one predicate of each query (Conjunctive Normal Form). All process instance query properties can be used except for: sorting See the User guide for more information about OR queries.

​
sorting
object[] | null

Apply sorting of the result

Response

Request successful.

​
id
string | null

The id of the process instance.

​
definitionId
string | null

The id of the process definition that this process instance belongs to.

​
businessKey
string | null

The business key of the process instance.

​
caseInstanceId
string | null

The id of the case instance associated with the process instance.

​
ended
boolean | null
deprecated

A flag indicating whether the process instance has ended or not. Deprecated: will always be false!

​
suspended
boolean | null

A flag indicating whether the process instance is suspended or not.

​
tenantId
string | null

The tenant id of the process instance.

​
links
object[] | null

The links associated to this resource, with method, href and rel.