Get a variable

GET 
/v1/variables/:variableId

Get the variable details by variable id.

Request

Path Parameters

variableId stringrequired

The ID of the variable.

Responses

200

On success returned.

application/json

Schema

Schema

id string

The ID of the variable.

name string

The name of the variable.

value string

The full value of the variable.

draft object

The draft value of the variable.

value string

The value of the variable.

tenantId string

The tenant ID associated with the variable.

Example (from schema)

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

404

An error is returned when the variable with the variableId is not found.

application/problem+json

Schema

Schema

status int32

An integer that represents the HTTP status code of the error response. For example, 400 indicates a "Bad Request" error, 404 indicates a "Not Found" error, and so on.

message string

A string that provides a brief description of the error that occurred.

instance string

Error instance UUID for lookup (eg. in log messages).

Example (from schema)

{
  "status": 0,
  "message": "string",
  "instance": "string"
}

Loading...