Dimension Service API  2.0.0
api indexresource index

DELETE dimensions/id/{id}

since: 0.6
Logically deletes a single dimension, identified by its system-generated, permanent ID. As a result of this operation, all data stored within this dimension, including the structure of its aspects, attributes, etc., will immediately become inaccessible.

This is a privileged operation.

There is an alternate resource available for accessing a dimension by its externally-provided name.

Path Elements

id
0.6required
string
The UUID identifier of the dimension to be deleted.

example value

c689acc7-ee13-3482-aa7b-c6a13419431c

Request Headers

pros-dimension-consistency
0.13optional
string
pros-dimension-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

Resource Information

Response Content
json
Success Statuses
204  NO CONTENT
Error Statuses
404  NOT FOUND
409  CONFLICT
Other Methods

Example 1

Request:

Response:
HTTP/1.1  204  NO CONTENT

Error Example - does not exist

see: DIM-001001

Request:

Response:
HTTP/1.1  404  NOT FOUND 

{
  "errorID"     : "DIM-001001",
  "errorMessage": "Sorry, the requested dimension 'c689acc7-ee13-3482-aa7b-c6a13419431c' does not exist.",
  "requestID"   : "DIM-0800200c9a66"
}

Error Example - concurrent operations

see: DIM-001010

Request:

Response:
HTTP/1.1  409  CONFLICT 

{
  "errorID"     : "DIM-001010",
  "errorMessage": "This operation could not be completed because the dimension was modified by another operation.",
  "requestID"   : "DIM-0800200c9a66"
}