Dimension Service API  2.0.0
api indexresource index

GET {+dimensionNode}/attributes/name/{name}

since: 0.6
Returns a single object describing the attribute value for a node, identified by the attribute's externally-provided name.

Path Elements

+dimensionNode
0.6required
string
The URI path to a specific dimension node (whether by ID or by name).
name
0.6required
string
The unique string name of the desired node attribute, as used by external systems.

example value

POP

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
204  NO CONTENT
Error Statuses
404  NOT FOUND
Other Methods

Example 1

Request:

Response:
HTTP/1.1  200  OK 

{
  "type": "integer",
  "attrID": "c689acc7-ee13-3482-aa7b-c6a13419431c",
  "attrName": "POPULATION",
  "integer": "2076189",
  "text": "2,076,189"
}

Example - attribute has no value for this node

Request:

Response:
HTTP/1.1  204  NO CONTENT

Error Example - does not exist

see: DIM-001401

Request:

Response:
HTTP/1.1  404  NOT FOUND 

{
  "errorID"     : "DIM-01401",
  "errorMessage": "Sorry, the requested attribute 'COLOR' does not exist.",
  "requestID"   : "DIM-333c9de29c3921f6"
}