Retrieve an instance of configurations

get

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

Request

Path Parameters

Response

Supported Media Types

Default Response

Body ()
Contains information about configuration settings within the system.
Root Schema : configurations
Type: object
Contains information about configuration settings within the system.
Show Source
Nested Schema : namedIDs-configurations-dataType
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 custom configuration object:

https://your_site_interface/services/rest/connect/version/configurations/configuration_id

Request URI example

https://mysite.example.com/services/rest/connect/v1.4/configurations/1000002

Response body example

{
  "id": 1000002,
  "lookupName": "CUSTOM_CFG_my_config",
  "dataType": {
    "id": 3,
    "lookupName": "Text"
  },
  "name": "CUSTOM_CFG_my_config",
  "value": "Default text goes here.",
  "links": [
    {
      "rel": "self",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/configurations/1000002"
    },
    {
      "rel": "canonical",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/configurations/1000002"
    },
    {
      "rel": "describedby",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/configurations",
      "mediaType": "application/schema+json"
    }
  ]
}