Hierarchical Value Service API  future
api index

MergeScopesBatchResponse Object

since: 0.51
A MergeScopesBatchRequest is a single object a list of SingleScopeBatches. Both the key and records fields of the SingleScopeBatches are required and can not be null. The key field can not be empty but records can be.

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

Fields

batch
0.1required
array of MergeSingleScopeBatchResult
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.
scopeErrorCount
0.50required
integer
The number of scope operations that failed. Can not be null

Related API Resources

Example - Response with 2 operations, 1 successful and 1 failed

    
    {
      "scopeErrorCount": 1,
      "batch": [
        {
          "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"
          }
        },
        {
          "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
                    }
                  ]
                }
              ]
            }
          }
        }
      ]
    }