Dimension Service API  2.0.0
api indexresource index

POST {+dimensionAspect}/nodes/id

since: 0.17
Given a dimension node ID list, returns an expanded list of dimension nodes with more details including aspect IDs, labels and names, in the context of a particular dimension aspect. Nodes in the result list are in the same order as the input list. A null object in the result list corresponds to an input node ID that is a non-existing node.

Path Elements

+dimensionAspect
0.17required
string
The URI path to a specific dimension aspect (whether by ID or by name).

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

Request Body

id
0.17required
string
One or more dimension node IDs that are expanded.

Extended description

This method provides a batch operation to retrieve details of multiple dimension nodes in the context of a particular dimension aspect, given that their node IDs are known. Instead of multiple calls of GET {+dimensionAspect}/nodes/id/{id} on each dimension node ID, a single call to this method with the dimension node IDs passed in as parameters retrieves the same result more efficiently.

The response header pros-batch-errors indicates the number of elements with errors in the response body. This header is only returned when the status code is 200 and errors are present in the response, otherwise the header is omitted.

Resource Information

Request Content
form
Response Content
json
Response Object
Success Statuses
200  OK
Error Statuses
400  BAD REQUEST

Example - retrieve details of a list of nodes referenced by IDs in context of an aspect name

Request:

id=d60abd09-f492-3902-8f35-5448709f18cc&id=09724d38-dd06-3e3b-b316-b57501a02772

Response:
HTTP/1.1  200  OK 

{
  [
    {
      "aspect" : {"aspectID":"85921462-8431-3951-97c0-558f7b5f8ffc"},
      "id"     : "d60abd09-f492-3902-8f35-5448709f18cc",
      "label"  : {"locale":"en","value":"Washington"},
      "name"   : "US-DC-Washington"
    },
    {
      "aspect" : {"aspectID":"85921462-8431-3951-97c0-558f7b5f8ffc"},
      "id"     : "09724d38-dd06-3e3b-b316-b57501a02772",
      "label"  : {"locale":"en","value":"Fort Wayne"},
      "name"   : "US-IN-Fort Wayne"
    }
  ]
}

Example - retrieve details of a list of nodes referenced by IDs in context of an aspect ID

Request:

id=d60abd09-f492-3902-8f35-5448709f18cc&id=09724d38-dd06-3e3b-b316-b57501a02772

Response:
HTTP/1.1  200  OK 

{
  [
    {
      "aspect" : {"aspectID":"85921462-8431-3951-97c0-558f7b5f8ffc"},
      "id"     : "d60abd09-f492-3902-8f35-5448709f18cc",
      "label"  : {"locale":"en","value":"Washington"},
      "name"   : "US-DC-Washington"
    },
    {
      "aspect" : {"aspectID":"85921462-8431-3951-97c0-558f7b5f8ffc"},
      "id"     : "09724d38-dd06-3e3b-b316-b57501a02772",
      "label"  : {"locale":"en","value":"Fort Wayne"},
      "name"   : "US-IN-Fort Wayne"
    }
  ]
}

Example - one or more nodes do not exist

Request:

id=d60abd09-f492-3902-8f35-5448709f18cc&id=09724d38-dead-beef-b316-b57501a02772

Response:
HTTP/1.1  200  OK 

{
  [
     {
       "aspect" : {"aspectID": "2b848a8c-c886-3253-921a-77c43cd50aae"},
       "id"     : "4be24f04-a3b7-37dc-9573-ae1da864d3df",
       "label"  : {"locale": "en", "value": "Washington"},
       "name"   : "US-WA"
     },
     null
  ]
}

Error Example - at least one node ID is not a valid UUID

Request:

id=4be24f04-a3b7-xxxx-9573-ae1da864d3df

Response:
HTTP/1.1  400  BAD REQUEST