Dimension Service API  2.0.0
api indexresource index

PUT {+dimensionNode}/name

since: 0.6
Renames the node by assigning a new external name. As a result of this operation, the externally-provided name previously used will become inaccessible and the name provided by this operation must be used in all future requests that access the node by name.

This is a privileged operation.

Path Elements

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

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

Request Content
text/plain
Response Content
json
Success Statuses
204  NO CONTENT
Error Statuses
400  BAD REQUEST
409  CONFLICT

Example - rename node referenced by ID

Request:

All_Cities

Response:
HTTP/1.1  204  NO CONTENT

Example - rename node referenced by name

Request:

US-TX-Space_City

Response:
HTTP/1.1  204  NO CONTENT

Error Example - blank or missing new name

see: DIM-001221

Request:

Response:
HTTP/1.1  400  BAD REQUEST 

{
  "errorID"     : "DIM-001221",
  "errorMessage": "Sorry, when renaming a node the new name must not be missing or blank.",
  "requestID"   : "DIM-0800200c9a66"
}

Error Example - name conflict with another node

see: DIM-001222

Request:

US-TX-Austin

Response:
HTTP/1.1  409  CONFLICT 

{
  "errorID"     : "DIM-001222",
  "errorMessage": "Sorry, the node cannot be renamed 'US-TX-Austin' because
                   that name is already used.  Please try again using a different name.",
  "requestID"   : "DIM-0800200c9a66"
}

Error Example - concurrent operations

see: DIM-001220

Request:

US-TX-H-Town

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"
}