Query process instances

POST 
/process-instances/search

Search for process instances based on given criteria.

Request

application/json

Body

sort object[]
Sort field criteria.
Array [
field stringrequired
The field to sort by.
order SortOrderEnum
Possible values: [ASC, DESC]
Default value: ASC
The order in which to sort the related field.
]
page object

Pagination criteria.

from int32

The index of items to start searching from.

limit int32

The maximum number of items to return in one request.

searchAfter object[]

Items to search after. Correlates to the lastSortValues property of a previous search response.

searchBefore object[]

Items to search before. Correlates to the firstSortValues property of a previous search response.

filter object
Process instance search filter.
processInstanceKey object
The key of this process instance.
oneOf
MOD1
integer
AdvancedLongFilter
$eq int64
Checks for equality with the provided value.
$neq int64
Checks for inequality with the provided value.
$exists boolean
Checks if the current property exists.
$in int64[]
Checks if the property matches any of the provided values.
$gt int64
Greater than comparison with the provided value.
$gte int64
Greater than or equal comparison with the provided value.
$lt int64
Lower than comparison with the provided value.
$lte int64
Lower than or equal comparison with the provided value.
processDefinitionId object
The process definition ID.
oneOf
MOD1
string
AdvancedStringFilter
$eq string
Checks for equality with the provided value.
$neq string
Checks for inequality with the provided value.
$exists boolean
Checks if the current property exists.
$in string[]
Checks if the property matches any of the provided values.
$like string
Checks if the property matches the provided like value. Supported wildcard characters depend on the configured search client.
processDefinitionName object
The process definition name.
oneOf
MOD1
string
AdvancedStringFilter
$eq string
Checks for equality with the provided value.
$neq string
Checks for inequality with the provided value.
$exists boolean
Checks if the current property exists.
$in string[]
Checks if the property matches any of the provided values.
$like string
Checks if the property matches the provided like value. Supported wildcard characters depend on the configured search client.
processDefinitionVersion object
The process definition version.
oneOf
MOD1
integer
AdvancedIntegerFilter
$eq int32
Checks for equality with the provided value.
$neq int32
Checks for inequality with the provided value.
$exists boolean
Checks if the current property exists.
$gt int32
Greater than comparison with the provided value.
$gte int32
Greater than or equal comparison with the provided value.
$lt int32
Lower than comparison with the provided value.
$lte int32
Lower than or equal comparison with the provided value.
$in int32[]
Checks if the property matches any of the provided values.
processDefinitionVersionTag object
The process definition version tag.
oneOf
MOD1
string
AdvancedStringFilter
$eq string
Checks for equality with the provided value.
$neq string
Checks for inequality with the provided value.
$exists boolean
Checks if the current property exists.
$in string[]
Checks if the property matches any of the provided values.
$like string
Checks if the property matches the provided like value. Supported wildcard characters depend on the configured search client.
processDefinitionKey object
The process definition key.
oneOf
MOD1
integer
AdvancedLongFilter
$eq int64
Checks for equality with the provided value.
$neq int64
Checks for inequality with the provided value.
$exists boolean
Checks if the current property exists.
$in int64[]
Checks if the property matches any of the provided values.
$gt int64
Greater than comparison with the provided value.
$gte int64
Greater than or equal comparison with the provided value.
$lt int64
Lower than comparison with the provided value.
$lte int64
Lower than or equal comparison with the provided value.
parentProcessInstanceKey object
The parent process instance key.
oneOf
MOD1
integer
AdvancedLongFilter
$eq int64
Checks for equality with the provided value.
$neq int64
Checks for inequality with the provided value.
$exists boolean
Checks if the current property exists.
$in int64[]
Checks if the property matches any of the provided values.
$gt int64
Greater than comparison with the provided value.
$gte int64
Greater than or equal comparison with the provided value.
$lt int64
Lower than comparison with the provided value.
$lte int64
Lower than or equal comparison with the provided value.
parentFlowNodeInstanceKey object
The parent flow node instance key.
oneOf
MOD1
integer
AdvancedLongFilter
$eq int64
Checks for equality with the provided value.
$neq int64
Checks for inequality with the provided value.
$exists boolean
Checks if the current property exists.
$in int64[]
Checks if the property matches any of the provided values.
$gt int64
Greater than comparison with the provided value.
$gte int64
Greater than or equal comparison with the provided value.
$lt int64
Lower than comparison with the provided value.
$lte int64
Lower than or equal comparison with the provided value.
startDate object
The start date.
oneOf
MOD1
string
AdvancedDateTimeFilter
$eq date-time
Checks for equality with the provided value.
$neq date-time
Checks for inequality with the provided value.
$exists boolean
Checks if the current property exists.
$gt date-time
Greater than comparison with the provided value.
$gte date-time
Greater than or equal comparison with the provided value.
$lt date-time
Lower than comparison with the provided value.
$lte date-time
Lower than or equal comparison with the provided value.
$in date-time[]
Checks if the property matches any of the provided values.
endDate object
The end date.
oneOf
MOD1
string
AdvancedDateTimeFilter
$eq date-time
Checks for equality with the provided value.
$neq date-time
Checks for inequality with the provided value.
$exists boolean
Checks if the current property exists.
$gt date-time
Greater than comparison with the provided value.
$gte date-time
Greater than or equal comparison with the provided value.
$lt date-time
Lower than comparison with the provided value.
$lte date-time
Lower than or equal comparison with the provided value.
$in date-time[]
Checks if the property matches any of the provided values.
state object
The process instance state.
oneOf
AdvancedProcessInstanceStateFilter
$eq ProcessInstanceStateEnum
Possible values: [ACTIVE, COMPLETED, CANCELED]
Checks for equality with the provided value.
$neq ProcessInstanceStateEnum
Possible values: [ACTIVE, COMPLETED, CANCELED]
Checks for inequality with the provided value.
$exists boolean
Checks if the current property exists.
$in ProcessInstanceStateEnum[]
Possible values: [ACTIVE, COMPLETED, CANCELED]
Checks if the property matches any of the provided values.
$like string
Checks if the property matches the provided like value. Supported wildcard characters depend on the configured search client.
hasIncident boolean
Whether this process instance has a related incident or not.
tenantId object
The tenant ID.
oneOf
MOD1
string
AdvancedStringFilter
$eq string
Checks for equality with the provided value.
$neq string
Checks for inequality with the provided value.
$exists boolean
Checks if the current property exists.
$in string[]
Checks if the property matches any of the provided values.
$like string
Checks if the property matches the provided like value. Supported wildcard characters depend on the configured search client.
variables object[]
The process instance variables.
Array [
name string
Name of the variable.
value string
The value of the variable.
]

Responses

200

The process instance search result.

application/json

Schema

Schema

page object

Pagination information about the search results.

totalItems int64

Total items matching the criteria.

firstSortValues object[]

The sort values of the first item in the result set. Use this in the searchBefore field of an ensuing request.

lastSortValues object[]

The sort values of the last item in the result set. Use this in the searchAfter field of an ensuing request.

items object[]
The matching process instances.
Array [
processInstanceKey int64
The key of this process instance.
processDefinitionId string
The process definition ID.
processDefinitionName string
The process definition name.
processDefinitionVersion int32
The process definition version.
processDefinitionVersionTag string
The process definition version tag.
processDefinitionKey int64
The process definition key.
parentProcessInstanceKey int64
The parent process instance key.
parentFlowNodeInstanceKey int64
The parent flow node instance key.
startDate date-time
The start date.
endDate date-time
The end date.
state ProcessInstanceStateEnum
Possible values: [ACTIVE, COMPLETED, CANCELED]
The state, one of ACTIVE, COMPLETED, CANCELED.
hasIncident boolean
Whether this process instance has a related incident or not.
tenantId string
The tenant ID.
]

Example (from schema)

{
  "items": [
    {
      "processInstanceKey": 0,
      "processDefinitionId": "string",
      "processDefinitionName": "string",
      "processDefinitionVersion": 0,
      "processDefinitionVersionTag": "string",
      "processDefinitionKey": 0,
      "parentProcessInstanceKey": 0,
      "parentFlowNodeInstanceKey": 0,
      "startDate": "2024-12-13T13:19:42.544Z",
      "endDate": "2024-12-13T13:19:42.544Z",
      "hasIncident": true,
      "tenantId": "string"
    }
  ],
  "page": {
    "totalItems": 0,
    "firstSortValues": [
      {}
    ],
    "lastSortValues": [
      {}
    ]
  }
}

400

The process instance search query failed. More details are provided in the response body.

application/problem+json

Schema

Schema

type uri

Default value: about:blank

A URI identifying the problem type.

title string

A summary of the problem type.

status int32

Possible values: >= 400 and <= 600

The HTTP status code for this problem.

detail string

An explanation of the problem in more detail.

instance uri

A URI identifying the origin of the problem.

Example (from schema)

{
  "type": "about:blank",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

401

The request lacks valid authentication credentials.

application/problem+json

Schema

Schema

type uri

Default value: about:blank

A URI identifying the problem type.

title string

A summary of the problem type.

status int32

Possible values: >= 400 and <= 600

The HTTP status code for this problem.

detail string

An explanation of the problem in more detail.

instance uri

A URI identifying the origin of the problem.

Example (from schema)

{
  "type": "about:blank",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

403

Forbidden. The request is not allowed.

application/problem+json

Schema

Schema

type uri

Default value: about:blank

A URI identifying the problem type.

title string

A summary of the problem type.

status int32

Possible values: >= 400 and <= 600

The HTTP status code for this problem.

detail string

An explanation of the problem in more detail.

instance uri

A URI identifying the origin of the problem.

Example (from schema)

{
  "type": "about:blank",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

500

An internal error occurred while processing the request.

application/problem+json

Schema

Schema

type uri

Default value: about:blank

A URI identifying the problem type.

title string

A summary of the problem type.

status int32

Possible values: >= 400 and <= 600

The HTTP status code for this problem.

detail string

An explanation of the problem in more detail.

instance uri

A URI identifying the origin of the problem.

Example (from schema)

{
  "type": "about:blank",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

Loading...