Hierarchical Value Service API  future
api index

MergeSingleScopeBatchResult Object

since: 0.51
Represents the results of a single scope operation in the context of a batch of single scope operations. Can represent either an error result or a successful result.

Exactly 1 of the 2 fields error or data will be non-null.

Fields

data
0.1required
A list of the scopes that were modified. Can not be null. Has the same size and ordering as the batch list in the request.
error
0.50required
Description of the error that occurred

Related API Objects

Example - The result of a successful operation

    
    {
      "data": {
        "result": {
          "tableId": "bb18498a-3228-425a-816c-481bac1030ca",
          "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
                }
              ]
            }
          ]
        }
      }
    }
    

Example - The result of a failed operation

    
    {
      "error": {
        "errorID": "HVS-004014",
        "errorMessage": "Example error message",
        "resourceType": "scope",
        "resourceID": "type-specific-ID-c689acc7-ee13-3482-aa7b-c6a13419431c",
        "requestID": "d0af9f1b-3159-4212-940e-ce984c19e8d3"
      }
    }