Dimension Service API  2.0.0
api index

ResolvedItem Object

since: 0.18
Polymorphic container for objects. The contents of this object will always consist of exactly one of the fields defined below.

Fields

node
0.18optional
A successfully resolved, non-null node object.
error
0.18optional
Indicates that errors were encountered while trying to resolve the intended instance of this object.

Related API Objects

Example - Successfully resolved node

{
  "node": {
    "id": "32b16534-406d-3436-b4c6-c61f24874650",
    "name": "US-TX-Houston",
    "label": { "locale": "en", "value": "Houston" },
    "aspect": { "aspectID": "85921462-8431-3951-97c0-558f7b5f8ffc" },
    "ancestors": [
      {
        "aspectID": "2b848a8c-c886-3253-921a-77c43cd50aae",
        "nodeID": "7baaa4ab-dd43-31a2-9454-ebc60fb910d5"
      },
      {
        "aspectID": "6ddc09dc-4560-31d9-854e-9fe670374eb2",
        "nodeID": "7516fd43-adaa-3e0b-8a65-a672c39845d2"
      }
    ]
  }
}
  

Example - ResolvedItem returned when resolution fails

{
  "error": {
    "fieldID": "dimName",
    "fieldValue": "PRODUCTSS",
    "errorID": "DIM-001001",
    "errorMessage": "Sorry, the requested dimension 'PRODUCTSS' does not exist."
  }
}