Dimension Service API  2.0.0
api indexresource index

PUT {+dimensionNode}/attributes/id/{id}

since: 0.6
Sets a single attribute value for a specific node, identified by the attribute's system-generated, permanent ID. The new value must match the type and satisfy all constraints defined for the attribute.

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).
id
0.6required
string
The UUID identifier of the attribute for which the value is to be set.

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

Request Content
application/json
Request Object
Response Content
json
Success Statuses
204  NO CONTENT
Error Statuses
404  NOT FOUND
400  BAD REQUEST
Other Methods

Example - set an attribute value referenced by ID

Request:

{
  "type"     : "integer",
  "integer"  : "2085254"
}

Response:
HTTP/1.1  204  NO CONTENT

Error Example - does not exist

see: DIM-001401

Request:

{
  "type"     : "integer",
  "integer": "2085254"
}

Response:
HTTP/1.1  404  NOT FOUND 

{
  "errorID"     : "DIM-001401",
  "errorMessage": "Sorry, the requested attribute '85921462-8431-3951-97c0-558f7b5f8ffc' does not exist.",
  "requestID"   : "DIM-95bf317e9f42ce67"
}

Error Example - failed to satisfy all constraints

see: DIM-001415

Request:

{
  "type"     : "integer",
  "integer"  : "-1"
}

Response:
HTTP/1.1  400  BAD REQUEST 

{
  "errorID"     : "DIM-001415",
  "errorMessage": "Sorry, the provided attribute value could not be stored because it
                   failed to satisfy all constraints.",
  "requestID"   : "DIM-33c631dbd032439",
  "details"     : [{
    "errorID"     : "DIM-001416",
    "errorMessage": "Sorry, the value given was out of the range allowed by the attribute.",
    "integer"   : -1,
    "min": 0
  }]
}

Error Example - missing request payload

Request:


                  Response:
HTTP/1.1 
                  400 
                  BAD REQUEST