Dimension Service API  2.0.0
api indexresource index

GET {+dimensionAspect}/nodes

since: 0.6
Searches all nodes within a specific dimension aspect and returns a paged list of matching nodes.

Path Elements

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

Query Parameters

q
0.6required
string
The search terms, consisting of one or more substrings, words, or phrases. Matches will be considered based on node names and also the best localized label available for the user's preferred language or locale.
0.6 min length: 1
perPage
0.6optional
string
A positive integer value specifying the maximum number of results per page. The provided value may be silently altered by the service based on the valid range specified here or other runtime criteria.
0.6 min: 10
0.6 max: 100
0.6 default value: 50
ancestorId
0.17optional
string
The UUID of a node in the current dimension. If provided, the search returns only those nodes that declare an ancestor with this UUID (i.e., nodes that are descendant from a node with the given UUID).

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.
pros-dimension-include
0.17optional
string

pros-dimension-include is an optional HTTP header used for clients to indicate whether data values that are omitted by default should be returned by APIs of the PROS Dimension Service. Its value consists of one or more values as listed below. When multiple values are specified, the ASCII comma charater must be used as a separator. There is a trade-off between data completeness and service performance. Higher data completeness may result in lower availability and/or lower performance.

When node.ancestor.id is specified, a result set of a request that returns dimension nodes contains members exposing their ancestor node IDs as well as other properties.

When node.ancestor.name is specified, a result set of a request that returns dimension nodes contains members exposing their ancestor node names as well as other properties.

When node.aspect.name is specified, a result set of a request that returns dimension nodes contains members exposing their aspect names alongside their aspect IDs.

When node.label.allLocales is specified, a result set of a request that returns dimension nodes contains members exposing the whole list of labels corresponding to all available locales as well as other properties.

0.17 valid values:
  • node.ancestor.id
  • node.ancestor.name
  • node.aspect.name
  • node.label.allLocales

Resource Information

Response Content
json
Response Object
Success Statuses
200  OK
Other Methods

Example 1

Request:

Response:
HTTP/1.1  200  OK 

{
  "data": [
    {
      "aspect": {
        "aspectID": "2b848a8c-c886-3253-921a-77c43cd50aae"
      },
      "id": "4be24f04-a3b7-37dc-9573-ae1da864d3df",
      "label": {
        "locale": "en",
        "value": "Washington"
      },
      "name": "US-WA"
    }
  ],
  "meta": {
    "next": {
      "page": "AAAAAC8-sZBz_____w",
      "perPage": "50",
      "q": "Washington"
    }
  }
}

Example 2

Request:

Response:
HTTP/1.1  200  OK 

{
  {
    "data": [
      {
        "ancestors": [
          {
            "aspectID": "6ddc09dc-4560-31d9-854e-9fe670374eb2",
            "nodeID": "7516fd43-adaa-3e0b-8a65-a672c39845d2"
          }
        ],
        "aspect": {
          "aspectID": "2b848a8c-c886-3253-921a-77c43cd50aae"
        },
        "id": "4be24f04-a3b7-37dc-9573-ae1da864d3df",
        "label": {
          "locale": "en",
          "value": "Washington"
        },
        "name": "US-WA"
      }
    ],
    "meta": {
      "next": {
        "page": "AAAAAC8-sZBz_____w",
        "perPage": "50",
        "q": "Washington"
      }
    }
  }
}

Example 3

Request:

Response:
HTTP/1.1  200  OK 

{
  "data": [
    {
      "ancestors": [
        {
          "aspectID": "6ddc09dc-4560-31d9-854e-9fe670374eb2",
          "nodeID": "7516fd43-adaa-3e0b-8a65-a672c39845d2",
          "nodeName": "US"
        }
      ],
      "aspect": {
        "aspectID": "2b848a8c-c886-3253-921a-77c43cd50aae"
      },
      "id": "4be24f04-a3b7-37dc-9573-ae1da864d3df",
      "label": {
        "locale": "en",
        "value": "Washington"
      },
      "name": "US-WA"
    }
  ],
  "meta": {
    "next": {
      "page": "AAAAAC8-sZBz_____w",
      "perPage": "10",
      "q": "Washington"
    }
  }
}

Example 4

Request:

Response:
HTTP/1.1  200  OK 

{
  "data": [
    {
      "ancestors": [
        {
          "aspectID": "6ddc09dc-4560-31d9-854e-9fe670374eb2",
          "nodeID": "7516fd43-adaa-3e0b-8a65-a672c39845d2",
          "nodeName": "US"
        }
      ],
      "aspect": {
        "aspectID": "2b848a8c-c886-3253-921a-77c43cd50aae",
        "aspectName": "STATE"
      },
      "id": "4be24f04-a3b7-37dc-9573-ae1da864d3df",
      "label": {
        "locale": "en",
        "value": "Washington"
      },
      "labels": [
        {
          "locale": "en",
          "value": "Washington"
        }
      ],
      "name": "US-WA"
    }
  ],
  "meta": {
    "next": {
      "page": "AAAAAC8-sZBz_____w",
      "perPage": "10",
      "q": "Washington"
    }
  }
}

Example - Search for nodes in an aspect, filtering on a required ancestor

Request:

Response:
HTTP/1.1  200  OK 

{
  "data": [
    {
      "ancestors": [
        {
          "aspectID": "2b848a8c-c886-3253-921a-77c43cd50aae",
          "nodeID": "41c068b2-f6d1-3cfe-bf22-7223ff489c1e",
          "nodeName": "US-NY"
        },
        {
          "aspectID": "6ddc09dc-4560-31d9-854e-9fe670374eb2",
          "nodeID": "7516fd43-adaa-3e0b-8a65-a672c39845d2",
          "nodeName": "US"
        }
      ],
      "aspect": {
        "aspectID": "85921462-8431-3951-97c0-558f7b5f8ffc"
      },
      "id": "bb557c6a-9a5e-349b-8bda-645c09742f0b",
      "label": {
        "locale": "en",
        "value": "New York (City)"
      },
      "name": "US-NY-New York"
    }
  ],
  "meta": {
    "next": {
      "ancestorId": "41c068b2-f6d1-3cfe-bf22-7223ff489c1e",
      "page": "AAAAAG8_sMHq_____w",
      "perPage": "50",
      "q": "new"
    }
  }
}