BatchResponse Object

A BatchResponse is a single object that contains lists of other objects, such as dimension nodes, wrapped in ResolvedItem containers.

Each ResolvedItem contains either

an object that was successfully resolved to a well-defined state, such as a DimensionNode); or,
an error with details indicating why the object could not be successfully resolved.

Fields

nodes

0.18optional

array of ResolvedItem

A JSON array of ResolvedItems containing either dimension nodes, or errors.

Example 1

{
  "nodes": [
    {
      "node": {
        "id": "4f5d99bb-5e65-4dd8-b4fa-60a6dad33306",
        "name": "Widget1234",
        "label": { "locale": "en", "value": "Widget 1234" },
        "aspect": { "aspectID": "cddc8c16-ca15-4842-ba2f-5e79915c3fbd" },
        "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"
          }
        ]
      }
    },
    {
      "error": {
        "fieldID": "nodeID",
        "fieldValue": "fbf4a554-d8b9-4f68-97da-5aa646ba4a9d",
        "errorID": "DIM-001201",
        "errorMessage": "Sorry, the requested dimension node 'fbf4a554-d8b9-4f68-97da-5aa646ba4a9d' does not exist."
      }
    },
    {
      "error": {
        "fieldID": "dimID",
        "fieldValue": "198498e5-66da-4fdd-97b8-4a7a2ae1ffaf",
        "errorID": "DIM-001001",
        "errorMessage": "Sorry, the requested dimension '198498e5-66da-4fdd-97b8-4a7a2ae1ffaf' does not exist."
      }
    },
    {
      "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"
          }
        ]
      }
    }
  ]
}

Fields

Related API Resources

Example 1