Skip to main content
Version: Next

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

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

Responses

The variable search result.

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.

  • ]
Loading...