Dimension Service API  2.0.0
api indexresource index

GET dimensions/name/{name}

since: 0.6
Returns a single object describing a specific dimension identified by its externally-provided name.

There is an alternate resource available for accessing a dimension by its system-generated, permanent ID.

Accept-Language HTTP Header will be used to set the languages the client is able to understand, and which locale variant is preferred.

Path Elements

name
0.6required
string
The unique string name of the desired dimension, as used by external systems.

Request Headers

pros-dimension-consistency
0.13optional
string
pros-dimension-consistency is an optional HTTP header used to define the data consistency level of the request. There is a trade off between data consistency and service availability and performance: higher data consistency can result in lower availability and slower performance, while lower data consistency can result in higher availability and faster performance.
0.13 valid values:
  • HIGHEST
  • HIGH
  • NORMAL
  • LOW
  • LOWEST
Accept-Language
0.13optional
string
The Accept-Language request HTTP header advertises which languages the client is able to understand, and which locale variant is preferred.

Resource Information

Response Content
json
Response Object
Success Statuses
200  OK
Other Methods

Example 1

Request:

Response:
HTTP/1.1  200  OK 

{
  "id"           :"c689acc7-ee13-3482-aa7b-c6a13419431c",
  "name"         :"LARGE_CITIES",
  "locales"      :["es","en","en-GB"],
  "defaultLocale":"es",
  "label":{
    "locale" :"en",
    "value"  :"Large Cities"
  },
  "rootAspect": {
    "id"     :"5289492c-f082-346c-a4a6-eec9f72f1ec3",
    "name"   :"WORLD",
    "label"  :{
      "locale":"en",
      "value" :"The World"
    }
  },
  "rootNode": {
    "id"     : "cc01e450-fe24-11e2-b778-0800200c9a66",
    "name"   : "Any",
    "label"  :{
      "locale":"en",
      "value" :"Anywhere"
    }
  },
  "aspects": [
    {
      "id"   :"6ddc09dc-4560-31d9-854e-9fe670374eb2",
      "name" :"COUNTRY",
      "label":{
        "locale":"en",
        "value" :"Country"
      }
    },
    {
      "id"   :"2b848a8c-c886-3253-921a-77c43cd50aae",
      "name" :"STATE",
      "label":{
        "locale":"en",
        "value" :"State/Province"
      }
    },
    {
      "id"   :"85921462-8431-3951-97c0-558f7b5f8ffc",
      "name" :"CITY",
      "label":{
        "locale":"en",
        "value" :"City"
      }
    }
  ]
}