Query user task variables (alpha)

POST 
/user-tasks/:userTaskKey/variables

Search for user task 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

Path Parameters

userTaskKey int64required

The key of the user task.

application/json

Body

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

Responses

200

The user task variables search response.

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