Hierarchical Value Service API  future
api index

Record Object

since: 0.1
This object contains one or more column values for a single entry within a table. The entry is uniquely associated with a set of distinct dimension nodes and a time span.

Fields

tableID
0.1required
string
The system-defined internal object ID of the table that this record is associated with. (in UUID canonical string format)

example value

0a4fa51c-c040-46a0-a3d0-63ca0e9ae699
start
0.1required
string
The start date and time that this record becomes effective.

The value must be a valid ISO 8601 string consisting of a fully specified date and an optional time component. If the time component is given, it must include values for hours, minutes, and seconds. A missing time component will be interpreted as midnight (00:00:00) on the given date. Time zones, sub-second precision, and durations in the ISO standard fields are not supported.

When omitted, the value defaults to the local date and time on the server receiving the request at the time the request is processed.

example value

2014-01-01T10:05:43
end
0.1required
string
The end date and time of this record. After this date and time, this value becomes invalid.

The value must be a valid ISO 8601 string consisting of a fully specified date and an optional time component. If the time component is given, it must include values for hours, minutes, and seconds. A missing time component will be interpreted as midnight (00:00:00) on the given date. Time zones, sub-second precision, and durations in the ISO standard fields are not supported.

When omitted, the value defaults to null, meaning the method lasts infinitely.

example value

2014-05-31T12:00:00
key
0.1required
array of string
A list of dimension reference and dimension node reference pairs. Each dimension reference can only appear once. Order of the pairs in the list are not significant. The dimension nodes have to be at the dimension aspects specified by an access level in the access sequence.
0.1 min length: 1
values
0.1required
array of Column
A list of typed data for defined columns in this table. The list is required when data is loaded into the table. If all columns are optional, an empty list must be provided; otherwise, the response will have http status 400 and an error message indicating that the values tag is missing. The order of the elements in the list is not significant. All required columns must exist in the list.
0.1 min length: 0
scale
0.29optional
ScaleStructure
An optional ScaleStructure describing the scale information used to scale values for the record. If the structure is not provided or the scale information is empty, the values will not be scaled during evaluation if scaling is requested by a formula.

Related API Resources

Related API Objects

Example - Example Record

  {
    "tableID": "160b4eb3-1512-4bdd-ab76-e402660bd32c",
    "start": "2014-04-14T10:05:43",
    "end": "2015-05-10T20: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": "Price",
        "value": "20",
        "type": "DECIMAL",
        "unit": "Each",
        "currency": "USD",
        "perQuantity" : 1
    }]
  }

Example - Example record with scale structure

  {
    "tableID": "160b4eb3-1512-4bdd-ab76-e402660bd32c",
    "start": "2014-04-14T10:05:43",
    "end": "2015-05-10T20: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": "Price",
        "value": "20",
        "type": "DECIMAL",
        "unit": "Each",
        "currency": "USD",
        "perQuantity" : 1
    }],
    {
      "type": "QUANTITY",
      "offsetType": "NUMERIC",
      "calcType": "CUMULATIVE",
      "offsetCurrency": "USD",
      "scale":[
        { "threshold": 0, "offset": 0 },
        { "threshold": 10, "offset": -10 },
        { "threshold": 20, "offset": -20 }
      ]
    }
  }

Example - Example input record with scale structure

  {
    "start": "2014-04-14T10:05:43",
    "end": "2015-05-10T20:14:21",
    "key": [{
        "dimName": "SAMPLE_PRODUCTS",
        "nodeName": "0011491975135"
    },
    {
        "dimName": "LARGE_CITIES",
        "nodeName": "US-TX"
    }],
    "values": [{
        "name": "Price",
        "value": "20",
        "type": "DECIMAL",
        "unit": "Each",
        "currency": "USD",
        "perQuantity" : 1
    }],
    {
      "type": "QUANTITY",
      "offsetType": "NUMERIC",
      "calcType": "CUMULATIVE",
      "offsetCurrency": "USD",
      "scale":[
        { "threshold": 0, "offset": 0 },
        { "threshold": 10, "offset": -10 },
        { "threshold": 20, "offset": -20 }
      ]
    }
  }