Dimension Service API  2.0.0
api indexresource index

PUT {+dimensionAspect}/name

since: 0.6
Renames the aspect 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 aspect by name.

This is a privileged operation.

Path Elements

+dimensionAspect
0.6required
string
The URI path to a specific dimension aspect (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 aspect referenced by ID

Request:

TOWN

Response:
HTTP/1.1  204  NO CONTENT

Example - rename aspect referenced by name

Request:

TOWN

Response:
HTTP/1.1  204  NO CONTENT

Error Example - blank or missing new name

see: DIM-001111

Request:

Response:
HTTP/1.1  400  BAD REQUEST 

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

Error Example - name conflict with another aspect

see: DIM-001112

Request:

TOWN

Response:
HTTP/1.1  409  CONFLICT 

{
  "errorID"     : "DIM-001112",
  "errorMessage": "Sorry, the aspect cannot be renamed 'TOWN' because
                   that name is already used.  Please try again using a different name.",
  "requestID"   : "DIM-0800200c9a66"
}

Error Example - concurrent operations

see: DIM-001110

Request:

TOWN

Response:
HTTP/1.1  409  CONFLICT 

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