Hierarchical Value Service API  future
api index

BatchRecordResponse Object

since: 0.29
A BatchRecordResponse is a single object that contains lists of other objects, such as records, wrapped in BatchRecordResponseItem containers.

Each BatchRecordResponseItem contains either

  • a record object that was successfully created or updated or deleted or
  • an error with details indicating why the object could not be successfully created or updated or deleted.

See also: BatchRecordRequest

Fields

records
0.29optional
array of BatchRecordResponseItem
A JSON array of BatchRecordResponseItems containing either records or errors.

Related API Resources

Example 1 

    {
      "records":
      [
        {
          "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 2 

    {
      "records":
      [
        {
          "error":
            {
              "errorID": "HVS-004017",
              "errorMessage": "The dimension LARGE_CITIES1 was not found.",
              "resourceType": "record"
            }
        }
      ]
    }

Example 3 

    {
      "records":
      [
        {
          "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
                }
              ]
            }
        },
        {
          "error":
            {
              "errorID": "HVS-004017",
              "errorMessage": "The dimension LARGE_CITIES1 was not found.",
              "resourceType": "record"
            }
        },
        {
          "error":
            {
              "errorID": "HVS-004051",
              "errorMessage": "Per quantity value is invalid.",
              "resourceType": "record"
            }
        }
      ]
    }