Query variables

POST 
/variables/search

Search for process and local variables 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

Variable filter request.

variableKey object

The key for this variable.

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.

name object

Name of the variable.

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.

value object

The value of the variable.

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.

scopeKey object

The key of the scope of this variable.

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.

processInstanceKey object

The key of the process instance of this variable.

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.

tenantId string

Tenant ID of this variable.

isTruncated boolean

Whether the value is truncated or not.

Responses

200

The variable 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 variables.
Array [
variableKey int64
The key for this variable.
name string
Name of this variable.
value string
Value of this variable.
fullValue string
Full value of this variable.
scopeKey int64
The key of the scope of this variable.
processInstanceKey int64
The key of the process instance of this variable.
tenantId string
Tenant ID of this variable.
isTruncated boolean
Whether the value is truncated or not.
]

Example (from schema)

{
  "items": [
    {
      "variableKey": 0,
      "name": "string",
      "value": "string",
      "fullValue": "string",
      "scopeKey": 0,
      "processInstanceKey": 0,
      "tenantId": "string",
      "isTruncated": true
    }
  ],
  "page": {
    "totalItems": 0,
    "firstSortValues": [
      {}
    ],
    "lastSortValues": [
      {}
    ]
  }
}

400

The user task 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...