Skip to main content
GET
/
process-instance
Get List
curl --request GET \
  --url http://{host}:{port}/{contextPath}/process-instance \
  --header 'Authorization: Basic <encoded-value>'
[
  {
    "links": [],
    "id": "anId",
    "definitionId": "aProcDefId",
    "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

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,
businessKey
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.

processInstanceIds
string

Filter by a comma-separated list of process instance ids.

businessKey
string

Filter by process instance business key.

businessKeyLike
string

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

caseInstanceId
string

Filter by case instance id.

processDefinitionId
string

Filter by the deployment the id belongs to.

processDefinitionKey
string

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

processDefinitionKeyIn
string

Filter by a comma-separated list of process definition keys. A process instance must have one of the given process definition keys.

processDefinitionKeyNotIn
string

Exclude instances by a comma-separated list of process definition keys. A process instance must not have one of the given process definition keys.

deploymentId
string

Filter by the deployment the id belongs to.

superProcessInstance
string

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

subProcessInstance
string

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

superCaseInstance
string

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

subCaseInstance
string

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

active
boolean
default:false

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

suspended
boolean
default:false

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

withIncident
boolean
default:false

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

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. A process instance must have one of the given tenant ids.

withoutTenantId
boolean
default:false

Only include process instances which belong to no tenant.

processDefinitionWithoutTenantId
boolean
default:false

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

activityIdIn
string

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

rootProcessInstances
boolean
default:false

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

leafProcessInstances
boolean
default:false

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

variables
string

Only include process instances 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.

variableNamesIgnoreCase
boolean
default:false

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

variableValuesIgnoreCase
boolean
default:false

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

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.

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