Query variables (alpha)

POST 
/variables/search

Search for process and local variables based on given criteria.

Note that this endpoint is an alpha feature and not enabled on Camunda clusters out of the box. The Camunda 8 API (REST) Overview page provides further details.

note

This endpoint is an alpha feature and may be subject to change in future releases.

Request

application/json

Body

sort object[]
Array [
field stringrequired
order string
Default value: asc
]
page object
from int32
limit int32
searchAfter object[]
searchBefore object[]
filter object

Variable filter request.

variableKey int64

The key for this variable.

name string

Name of the variable.

value string

The value of the variable.

scopeKey object

Long property with full advanced search capabilities.

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

Long property with full advanced search capabilities.

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
totalItems int64
firstSortValues object[]
lastSortValues object[]
items object[]
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"
}

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