Hierarchical Value Service API  future
api indexresource index

PUT {+link}/table

since: 0.6
Update link to link to a new destination. Only the tableID field in the payload will be used.

Path Elements

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

Request Headers

pros-hvs-consistency
0.13optional
string
pros-hvs-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
pros-rtpe-cache
0.35optional
string

pros-rtpe-cache is an optional HTTP header used to define the caching strategy used by Hierarchial Value Service for a request. This header helps control which internal caches should be used by the service when processing the request. There is a tradeoff between returning the most recent data and performance. Disabling caches will help ensure that the most recent data available are returned, but will likely increase the time required to process and respond to the request.

When disable.metadata is specified, caches related to table and dimension metadata will be disabled.

When disable.data is specified, caches related to table and dimension data will be disabled.

When disable.all is specified, all caches will be disabled.

When any cache is disabled, those caches will not be updated with values retrieved during a request.

0.35 valid values:
  • enable
  • disable.metadata
  • disable.data
  • disable.all

Resource Information

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

Example - Change Link To Link To Another Table

Request:

      
        {
          "tableID"  : "abcdef00-1234-5678-9012-34567890abcd"
        }

Response:
HTTP/1.1  204  NO CONTENT 


            

               
Error
                  Example
                  
                  - The Linked To Table Does Not Exist

               

                  see: HVS-004032

               
Request:

               
      
        {
          "tableID"  : "abcdef00-1234-5678-9012-34567890abcd"
        }
      
    

                  Response:
HTTP/1.1 
                  404 
                  NOT FOUND
               

               
        
          {
            "errorID"     : "HVS-004032",
            "errorMessage": "The table this link is linked to does not exist.  Table ID: abcdef00-1234-5678-9012-34567890abcd",
            "resourceType": "link",
            "requestID"   : "d0af9f1b-3159-4212-940e-ce984c19e8d4"
          }
        
      

            

               
Error
                  Example
                  
                  - Update Link Without Payload

               

                  see: HVS-004037

               
Request:

               

                  Response:
HTTP/1.1 
                  400 
                  BAD REQUEST
               

               
        
          {
            "errorID"     : "HVS-004036",
            "errorMessage": "Cannot update a link without a valid payload.",
            "resourceType": "link",
            "requestID"   : "d0af9f1b-3159-4212-940e-ce984c19e8d4"
          }
        
      

            

               
Error
                  Example
                  
                  - Update A Link To Link To Another Link

               

                  see: HVS-004040

               
Request:

               
      
        {
          "name"    : "linkToLink",
          "tableID" : "ff18498a-3228-425a-816c-481bac1030ca"
        }
      
    

                  Response:
HTTP/1.1 
                  400 
                  BAD REQUEST
               

               
        
          {
            "errorID"     : "HVS-004040",
            "errorMessage": "A link cannot link to another link.",
            "resourceType": "link",
            "requestID"   : "d0af9f1b-3159-4212-940e-ce984c19e8d4"
          }