Hierarchical Value Service API  future
api index

SingleScopeBatch Object

since: 0.40
A SingleScopeBatch is a single object that contains a dimension key and a list of records. All records in the list will be created with the dimension key as their scope. Upon response the tableId or error fields will be populated, depending on success or failure.

The request's records array must contain between 1 and 100 records, inclusive. Any other size results in an error.

Fields

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
records
0.1required
array of SingleScopeBatchRecord
A list of request items. Individual elements in this list may not be null.
0.1 min length: 1
0.1 max length: 100

Related API Resources

Related API Objects

Example - Create or Update Batch Request

    {
      "key":
          [
            {
              "dimName": "SAMPLE_PRODUCTS",
              "nodeName": "0011491975135"
            },
            {
              "dimName": "LARGE_CITIES",
              "nodeName": "US-TX"
            }
          ],
      "records":
      [
        {
          "start": "2014-04-14T10:05:43",
          "end": "2015-05-10T20:14:21",

          "values":
          [
            {
              "name": "Price",
              "value": "20",
              "type": "DECIMAL",
              "unit": "Each",
              "currency": "USD",
              "perQuantity" : 1
            }
          ]
        }
      ]
    }