Hierarchical Value Service API  future
api indexresource index

GET {+table}/data/nameKey

since: 0.1
Finds the most specific record defined for the given search key, date, and time.

There is a alternate resource available for searching records by using dimension ID and dimension node ID in the scope.

Request a record with scope at specific level using GET {+table}/data/nameKey/exact

Path Elements

+table
0.1required
string
The URI path to a specific table (whether by ID or by name).

Matrix Parameters

;columnName=...
appended to data
0.1optional
string

Used when only a subset of the existing column values is desired. By specifying specific column names, the requested record is filtered to only contain the specified columns. When no column names are specified, all existing columns are returned.

The text columnName is a placeholder and must be replaced with an exact column name from the table. Repeat as necessary for any additional columns desired, in any order. The value of the matrix parameter is reserved for future use and should not be specified.

example values

  • ;Competitor%20Price=
  • ;Base%20Price
  • ;Competitor%20Price;Base%20Price;AveragePrice
;searchDimensionName=...
appended to nameKey
0.1required
string

The scope specifies the dimensionality of where the record should be found and is made up of an unordered list of dimension - dimension node pairs, where each dimension can only appear once.

When associated with the nameKey it is required that in the scope both dimensions and dimension nodes are specified by names.

The scope will used to find a record by walking the access sequence of the table and returning the first matching record encountered.

The dimension name is placed on the left side of the equals sign of the matrix parameter and the dimension node name is placed on the right side.

example values

  • ;SAMPLE_PRODUCTS=0011491976134
  • ;SAMPLE_PRODUCTS=0011491976134;LARGE_CITIES=US-TX-HOUSTON

Query Parameters

on
0.1optional
string
The date-time without a time-zone in the ISO-8601 calendar system that is used to resolve the value, such as 2014-12-03T10:15:30. The precision is to the Second. Nanosecond field is ignored. The time fields are optional. If time is not specified, it is default to 00:00:00. If this parameter is not specified, the server time at which this request is processed is used.

example values

  • 2014-12-03T10:15:30
  • 2014-12-03T10:15
  • 2014-12-03

Request Headers

pros-hvs-consistency
0.13optional
string
pros-hvs-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
pros-rtpe-cache
0.35optional
string

pros-rtpe-cache is an optional HTTP header used to define the caching strategy used by Hierarchial Value Service for a request. This header helps control which internal caches should be used by the service when processing the request. There is a tradeoff between returning the most recent data and performance. Disabling caches will help ensure that the most recent data available are returned, but will likely increase the time required to process and respond to the request.

When disable.metadata is specified, caches related to table and dimension metadata will be disabled.

When disable.data is specified, caches related to table and dimension data will be disabled.

When disable.all is specified, all caches will be disabled.

When any cache is disabled, those caches will not be updated with values retrieved during a request.

0.35 valid values:
  • enable
  • disable.metadata
  • disable.data
  • disable.all

Resource Information

Response Content
json
Response Object
Success Statuses
200  OK
Other Methods

Example - Request Data Using names in Scope

Request:

Response:
HTTP/1.1  200  OK 


  {
    "tableID" : "bb18498a-3228-425a-816c-481bac1030ca",
    "start": "2014-04-14T10:05:43",
    "end": "2014-05-18T20:14:21",
    "key": [
      {
        "dimID"    : "28484058-4ffc-329b-94ff-63e1ddbd7189",
        "dimName"  : "SAMPLE_PRODUCTS",
        "nodeID"   : "27de4ae8-61be-3fff-a397-16362cafeba2",
        "nodeName" : "0011491975135"
      },
      {
        "dimID"    : "c689acc7-ee13-3482-aa7b-c6a13419431c",
        "dimName"  : "LARGE_CITIES",
        "nodeID"   : "7baaa4ab-dd43-31a2-9454-ebc60fb910d5",
        "nodeName" : "US-TX"
      }
    ],
    "values" : [
      {
        "name"  : "Forecasted Volume",
        "value" : "17.26172",
        "unit"  : "cubic feet"
        "perQuantity" : 1
      },
      {
        "name"     : "Historic Revenue",
        "value"    : "15.27181",
        "currency" : "USD",
        "perQuantity" : 0
      },
      {
        "name"     : "Product Cost",
        "value"    : "7.97181",
        "unit"     : "Each",
        "currency" : "DKR",
        "perQuantity" : 1
      },
      {
        "name"     : "Competitor Influence",
        "value"    : "High"
      }
    ]
  }

Example - Request Data Using names in Scope

Request:

Response:
HTTP/1.1  200  OK 


  {
    "tableID" : "bb18498a-3228-425a-816c-481bac1030ca",
    "start": "2014-04-14T10:05:43",
    "end": "2014-05-18T20:14:21",
    "key": [
      {
        "dimID"    : "28484058-4ffc-329b-94ff-63e1ddbd7189",
        "dimName"  : "SAMPLE_PRODUCTS",
        "nodeID"   : "27de4ae8-61be-3fff-a397-16362cafeba2",
        "nodeName" : "0011491975135"
      },
      {
        "dimID"    : "c689acc7-ee13-3482-aa7b-c6a13419431c",
        "dimName"  : "LARGE_CITIES",
        "nodeID"   : "7baaa4ab-dd43-31a2-9454-ebc60fb910d5",
        "nodeName" : "US-TX"
      }
    ],
    "values" : [
      {
        "name"  : "Forecasted Volume",
        "value" : "17.26172",
        "unit"  : "cubic feet",
        "perQuantity" : 1
      },
      {
        "name"     : "Competitor Influence",
        "value"    : "High"
      }
    ]
  }