Retrieve an instance of variables

get

/services/rest/connect/latest/variables/{id}

Request

Path Parameters

Response

Supported Media Types

Default Response

Body ()
A variable is a predefined shortcut for entering information instead of a long string of text.
Root Schema : variables
Type: object
A variable is a predefined shortcut for entering information instead of a long string of text.
Show Source
Nested Schema : variables-folder
Type: object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
Nested Schema : variables-interfaceValues
Type: object
The interface-specific value of a variable.
Show Source
  • siteInterfaces
    The console, windows, and pages used by staff members and customers to access the application and interact with a single knowledge base. The interface name determines the URL for the web site, the name of the system executables, and the .cfg directory name.
  • Maximum Length: 1333
    The text that will be used on this interface.
Nested Schema : variables-folder-parents
Type: object
NamedID in which the ID is read-only. Used for hierarchies, where caller can specify the parents by name, but cannot specify the parent IDs.
Show Source
Nested Schema : siteInterfaces
Type: object
The console, windows, and pages used by staff members and customers to access the application and interact with a single knowledge base. The interface name determines the URL for the web site, the name of the system executables, and the .cfg directory name.
Show Source
Nested Schema : namedIDs-siteInterfaces-language
Type: object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source

Examples

Use GET with the following syntax to retrieve data for a variable:

https://your_site_interface/services/rest/connect/version/variables/variable_id

Request URI example

https://mysite.example.com/services/rest/connect/v1.4/variables/1

Response body example

{
  "id": 1,
  "lookupName": "Phone_number",
  "displayOrder": 1,
  "folder": null,
  "interfaceValues": {
    "links": [
      {
        "rel": "self",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/variables/1/interfaceValues"
      }
    ]
  },
  "name": "Phone_number",
  "searchIndexable": false,
  "links": [
    {
      "rel": "self",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/variables/1"
    },
    {
      "rel": "canonical",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/variables/1"
    },
    {
      "rel": "describedby",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/variables",
      "mediaType": "application/schema+json"
    }
  ]
}