Dimension Service API  2.0.0
api indexresource index

POST {+dimensionAspect}/nodes/name

since: 0.17
Given a dimension node name 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 name 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 Body

name
0.17required
string
One or more dimension node names 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 names are known. Instead of multiple calls of GET {+dimensionAspect}/nodes/name/{name} on each dimension node name, a single call to this method with the dimension node names 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

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

Request:

name=US-DC-Washington&name=US-IN-Fort%20Wayne

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"
    },
    {
      "aspect" : {"aspectID":"6ddc09dc-4560-31d9-854e-9fe670374eb2"},
      "id"     : "7516fd43-adaa-3e0b-8a65-a672c39845d2",
      "label"  : {"locale":"en","value":"United States"},
      "name"   : "US"
    }
  ]
}

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

Request:

name=US-DC-Washington&name=US-IN-Fort%20Wayne

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"
    },
    {
      "aspect" : {"aspectID":"6ddc09dc-4560-31d9-854e-9fe670374eb2"},
      "id"     : "7516fd43-adaa-3e0b-8a65-a672c39845d2",
      "label"  : {"locale":"en","value":"United States"},
      "name"   : "US"
    }
  ]
}

Example - one or more node names do not exist

Request:

name=US-DC-Washington&name=XYZUnknownCity&name=US-IN-Fort%20Wayne

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,
    {
      "aspect" : {"aspectID":"6ddc09dc-4560-31d9-854e-9fe670374eb2"},
      "id"     : "7516fd43-adaa-3e0b-8a65-a672c39845d2",
      "label"  : {"locale":"en","value":"United States"},
      "name"   : "US"
    }
  ]
}