Dimension Service API  2.0.0
api indexresource index

DELETE {+dimension}/nodes/name/{name}

since: 0.6
Logically deletes a single node identified by its externally-provided name. As a result of this operation, all related data stored for this node, including any attribute values, relationships to other nodes, etc., will immediately become inaccessible.

This is a privileged operation. (Note: The special root node of a dimension cannot be deleted by this operation.)

Path Elements

+dimension
0.6required
string
The URI path to a specific dimension (whether by ID or by name).
name
0.6required
string
The string name of the node to be deleted.

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
403  FORBIDDEN
Other Methods

Example 1

Request:

Response:
HTTP/1.1  204  NO CONTENT

Error Example - does not exist

see: DIM-001201

Request:

Response:
HTTP/1.1  404  NOT FOUND 

{
  "errorID"     : "DIM-001201",
  "errorMessage": "Sorry, the requested dimension node 'US-TX-Chicago' does not exist.",
  "requestID"   : "DIM-0800200c9a66"
}

Error Example - concurrent operations

see: DIM-001220

Request:

Response:
HTTP/1.1  409  CONFLICT 

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

Error Example - attempting to delete the root node

see: DIM-001200

Request:

Response:
HTTP/1.1  403  FORBIDDEN 

{
  "errorID"     : "DIM-001200",
  "errorMessage": "The root node cannot be deleted except by removing its entire dimension.",
  "requestID"   : "DIM-0800200c9a66"
}