Variables API

The Variables API controller provides an API to query variables.

Endpoints

Get variable

Get the variable details by variable id.

URL

/v1/variables/{variableId}

Method

GET

Request parameters

Parameter name	Type	Required	Description
variableId	path	true	ID of the variable

HTTP request example

curl -X 'GET' \
'http://{host}/v1/variables/{variableId}' \
  -H 'accept: application/json' \
  -H 'Cookie: TASKLIST-SESSION={tasklistSessionId}'

Responses

caution

Starting with the 8.3 release, we're making changes to the response format for a 200 status. The returned JSON will be simplified as follows:

Current response:

{
  "id": "string",
  "name": "string",
  "value": "string",
  "isValueTruncated": true,
  "previewValue": "string"
}

New response (from next release):

{
  "id": "string",
  "name": "string",
  "value": "string"
}

HTTP status	Description	Response schema
200	On success	JSON object with VariableResponse structure
404	An error is returned when the variable with the variableId is not found.	JSON object with Error structure