Hierarchical Value Service API  future
api indexresource index

DELETE {+table}/data/idKey

since: 0.1

Deletes records matching a specific scope in a specified time range.

Unlike the search operation, this method does not traverse the access sequence and will only delete records exactly matching the given key.

Path Elements

+table
0.1required
string
The URI path to a specific table (whether by ID or by name).

Matrix Parameters

;searchDimensionID=...
appended to idKey
0.1optional
string

Identifies a single dimension which makes up part of the hierarchical scope, used to identify which records are to be deleted.

The searchDimensionID is placeholder text and must be replaced with the system-generated ID of the corresponding dimension. The value for the parameter must be the system-generated ID of an existing node within the same dimension. For keys involving more than one dimension, repeat as necessary in any order. It is illegal to specify multiple key values for the same dimension.

example values

  • ;c689acc7-ee13-3482-aa7b-c6a13419431c=7baaa4ab-dd43-31a2-9454-ebc60fb910d5
  • ;c689acc7-ee13-3482-aa7b-c6a13419431c=7baaa4ab-dd43-31a2-9454-ebc60fb910d5;28484058-4ffc-329b-94ff-63e1ddbd7189=27de4ae8-61be-3fff-a397-16362cafeba2

Query Parameters

on
0.1required
string

Marks the starting date and time of the range of records that will be deleted. The start time does not have a time zone associated and is following the ISO-8601 calendar system.

The precision is to the Second.

Nanosecond field is ignored.

example values

  • 2014-12-03T10:15:30
  • 2014-12-03T10:15
  • 2014-12-03
until
0.1required
string

Marks the end date and time of the range of records that will be deleted. The end time does not have a time zone associated and is following the ISO-8601 calendar system.

The precision is to the Second.

Nanosecond field is ignored.

example values

  • 2014-12-03T10:15:30
  • 2014-12-03T10:15
  • 2014-12-03

Request Headers

pros-hvs-consistency
0.13optional
string
pros-hvs-consistency is an optional HTTP header used to define the data consistency level of the request. There is a trade off between data consistency and service availability and performance: higher data consistency can result in lower availability and slower performance, while lower data consistency can result in higher availability and faster performance.
0.13 valid values:
  • HIGHEST
  • HIGH
  • NORMAL
  • LOW
  • LOWEST
pros-rtpe-cache
0.35optional
string

pros-rtpe-cache is an optional HTTP header used to define the caching strategy used by Hierarchial Value Service for a request. This header helps control which internal caches should be used by the service when processing the request. There is a tradeoff between returning the most recent data and performance. Disabling caches will help ensure that the most recent data available are returned, but will likely increase the time required to process and respond to the request.

When disable.metadata is specified, caches related to table and dimension metadata will be disabled.

When disable.data is specified, caches related to table and dimension data will be disabled.

When disable.all is specified, all caches will be disabled.

When any cache is disabled, those caches will not be updated with values retrieved during a request.

0.35 valid values:
  • enable
  • disable.metadata
  • disable.data
  • disable.all

Resource Information

Request Content
json
Response Content
json
Success Statuses
204  NO CONTENT
Other Methods

Example - Delete Data

Request:

Response:
HTTP/1.1  204  NO CONTENT