Hierarchical Value Service API  future
api index

BatchRecordRequestItem Object

since: 0.29
This object is an extension of Record datatype.

When creating a create or update request, same restrictions apply to each record in the request, as would apply when calling the non-batch create request to the specified table.

In the case of delete, scope is mandatory but start and end dates are optional. It is mandatory to include the "deleted" flag and it should be set to true.

If only start date is included, all the records matching given scope with effective start date greater than or equal to specified start date will be deleted from the system.

If only end date is included, all the records matching given scope with effective end date less than or equal to specified end date will be deleted from the system.

If neither start or end dates are specified in the request, then all the records matching given scope will be deleted from the system.

Fields

deleted
0.1optional
boolean
A boolean value set to true indicates this record needs to be deleted.
0.1 default value: false

Related API Objects

Example - Create or Update Request Item

    {
      "record":
        {
          "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
            }
          ]
        }
    }

Example - Delete Request Item

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