Finds the most specific record defined for the given search key, date, and time.
Since the idKey
is specified for the scope, it is required that the dimensions
and aspects are referred to by ID for exact
.
Unlike regular record retrieval which traverses the access sequence to find a matching record,
when using exact
only the specified level is used for matching.
The specified exact
level must be one of the existing levels in the access sequence.
Only dimension ID and aspect ID pairs can be used in exact
segment.
Path Elements
+table
string
|
The URI path to a specific table (whether
by ID or
by name).
|
Matrix Parameters
;columnName=...
appended to data
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
|
;searchDimensionID=...
appended to idKey
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 idKey it is required that in the scope
both dimensions and dimension nodes are specified by IDs.
The dimension ID is placed on the left side of the equals sign of the matrix parameter
and the dimension node ID is placed on the right side.
example values
;c689acc7-ee13-3482-aa7b-c6a13419431c=7baaa4ab-dd43-31a2-9454-ebc60fb910d5
;c689acc7-ee13-3482-aa7b-c6a13419431c=7baaa4ab-dd43-31a2-9454-ebc60fb910d5;28484058-4ffc-329b-94ff-63e1ddbd7189=27de4ae8-61be-3fff-a397-16362cafeba2
|
;levelDimensionID=...
appended to exact
string
|
Where a regular record retrieval occurs by matching the scope with one of access levels in the
access sequence of the table, using exact looks up a record with the given scope
that has to match that precise access level given. It will not walk all the access levels in
the access sequence to find a match.
This matrix parameter has dimension ID on the left side of the equals and an aspect ID on the right side.
example values
;28484058-4ffc-329b-94ff-63e1ddbd7189=2b848a8c-c886-3253-921a-77c43cd50aae
;c689acc7-ee13-3482-aa7b-c6a13419431c=1d631f4a-e341-2364-514f-11251ea31bfa
|
Query Parameters
on
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
|
Example
- Request Data Using IDs in Scope and Exact segments
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
}
]
}
Error
Example
- Request Data Using IDs, Multiple Aspects Specified for One Dimension
Request:
Response:
HTTP/1.1
400
BAD REQUEST
{
"errorID" : "HVS-004022",
"errorMessage": "Expected one aspect identifier per dimension in the access level restriction, found: 2.",
"resourceType": "record",
"requestID" : "d0af9f1b-3159-4212-940e-ce984c19e8d3"
}
Error
Example
- Request Data Using IDs, Aspect Not Exist
Request:
Response:
HTTP/1.1
400
BAD REQUEST
{
"errorID" : "HVS-004023",
"errorMessage": "Did not find the requested resource with ID: 2b848a8cc8863253,921a77c43cd50aae.",
"resourceType": "record",
"requestID" : "d0af9f1b-3159-4212-940e-ce984c19e8d3"
}
Error
Example
- Request Data Using IDs, Aspect Not Exist
Request:
Response:
HTTP/1.1
400
BAD REQUEST
{
"errorID" : "HVS-004024",
"errorMessage": "Required aspect value for dimension 28484058-4ffc-329b-94ff-63e1ddbd7189 was not set.",
"resourceType": "record",
"requestID" : "d0af9f1b-3159-4212-940e-ce984c19e8d3"
}