Hierarchical Value Service API  future
api indexresource index

PUT table/id/{id}

since: 0.1
Updates the table with the given payload. Everything is updated except for the name. To update the table name use Rename Table.

Path Elements

id
0.1required
string
UUID that is used to identify the table.

example value

cb2d8a2d-67e8-40c2-8884-1c77c5ddf251

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
Response Object
Success Statuses
200  OK
Error Statuses
400  BAD REQUEST
Other Methods

Example - Update Table Using Table ID

Request:


  {
    "name":"Special Events",
    "columns" : [
      {
        "name" : "Forecasted Volume",
        "dataType" : "DECIMAL",
        "constraints" : [
        {
          "name" : "unitRequired",
          "type" : "BOOLEAN",
          "value" : true
        }],
        "required" : true
      },
      {
        "name" : "Historic Revenue",
        "dataType" : "DECIMAL",
        "constraints" : [
        {
          "name" : "currencyRequired",
          "type" : "BOOLEAN",
          "value" : true
        }],
        "required" : true
      },
      {
        "name" : "Product Cost",
        "dataType" : "DECIMAL",
        "constraints" : [
        {
          "name" : "unitRequired",
          "type" : "BOOLEAN",
          "value" : true,
        },
        {
          "name" : "currencyRequired",
          "type" : "BOOLEAN",
          "value" : true
        }],
        "required" : true
      },
      {
        "name" : "Competitor Influence",
        "dataType" : "STRING",
        "required" : false
      }
    ],
    "accessSequence" : [
      {
        "accessLevel" : [
          {
            "dimID"    : "28484058-4ffc-329b-94ff-63e1ddbd7189",
            "aspectID" : "fbd99ad0-1b92-3baf-8686-772a39e3d065"
          },
          {
            "dimID"    : "c689acc7-ee13-3482-aa7b-c6a13419431c",
            "aspectID" : "85921462-8431-3951-97c0-558f7b5f8ffc"
          }
        ]
      },
      {
        "accessLevel" : [
          {
            "dimID"      : "28484058-4ffc-329b-94ff-63e1ddbd7189",
            "aspectID"   : "fbd99ad0-1b92-3baf-8686-772a39e3d065"
          },
          {
            "dimID"      : "c689acc7-ee13-3482-aa7b-c6a13419431c",
            "aspectID"   : "2b848a8c-c886-3253-921a-77c43cd50aae"
          }
        ]
      }
    ]
  }

Response:
HTTP/1.1  200  OK 


  {
    "id": "cb2d8a2d-67e8-40c2-8884-1c77c5ddf251",
    "name":"Special Events",
    "columns" : [
      {
        "name" : "Forecasted Volume",
        "dataType" : "DECIMAL",
        "constraints" : [
        {
          "name" : "unitRequired",
          "type" : "BOOLEAN",
          "value" : true
        }],
        "required" : true
      },
      {
        "name" : "Historic Revenue",
        "dataType" : "DECIMAL",
        "constraints" : [
        {
          "name" : "currencyRequired",
          "type" : "BOOLEAN",
          "value" : true
        }],
        "required" : true
      },
      {
        "name" : "Product Cost",
        "dataType" : "DECIMAL",
        "constraints" : [
        {
          "name" : "unitRequired",
          "type" : "BOOLEAN",
          "value" : true
        },
        {
          "name" : "currencyRequired",
          "type" : "BOOLEAN",
          "value" : true
        }],
        "required" : true
      },
      {
        "name" : "Competitor Influence",
        "dataType" : "STRING",
        "required" : false
      }
    ],
    "accessSequence" : [
      {
        "accessLevel" : [
          {
            "dimID"      : "28484058-4ffc-329b-94ff-63e1ddbd7189",
            "dimName"    : "SAMPLE_PRODUCTS",
            "aspectID"   : "fbd99ad0-1b92-3baf-8686-772a39e3d065",
            "aspectName" : "UPC"
          },
          {
            "dimID"      : "c689acc7-ee13-3482-aa7b-c6a13419431c",
            "dimName"    : "LARGE_CITIES",
            "aspectID"   : "85921462-8431-3951-97c0-558f7b5f8ffc",
            "aspectName" : "CITY"
          }
        ]
      },
      {
        "accessLevel" : [
          {
            "dimID"      : "28484058-4ffc-329b-94ff-63e1ddbd7189",
            "dimName"    : "SAMPLE_PRODUCTS",
            "aspectID"   : "fbd99ad0-1b92-3baf-8686-772a39e3d065",
            "aspectName" : "UPC"
          },
          {
            "dimID"      : "c689acc7-ee13-3482-aa7b-c6a13419431c",
            "dimName"    : "LARGE_CITIES",
            "aspectID"   : "2b848a8c-c886-3253-921a-77c43cd50aae",
            "aspectName" : "STATE"
          }
        ]
      }
    ],
    "dynamic"   : false,
    "createdBy" : "c3fb23a7-51d5-3f23-aae4-ea3ebcda987f"
  }

Example - Update Table to use Dynamic Column

Request:


{
  "name":"Special Forecasts",
  "dynamic" : true,
  "accessSequence" : [
    {
      "accessLevel" : [
        {
          "dimID"    : "28484058-4ffc-329b-94ff-63e1ddbd7189",
          "aspectID" : "fbd99ad0-1b92-3baf-8686-772a39e3d065"
        },
        {
          "dimID"    : "c689acc7-ee13-3482-aa7b-c6a13419431c",
          "aspectID" : "85921462-8431-3951-97c0-558f7b5f8ffc"
        }
      ]
    },
    {
      "accessLevel" :[
        {
          "dimID"    : "28484058-4ffc-329b-94ff-63e1ddbd7189",
          "aspectID" : "fbd99ad0-1b92-3baf-8686-772a39e3d065"
        },
        {
          "dimID"    : "c689acc7-ee13-3482-aa7b-c6a13419431c",
          "aspectID" : "2b848a8c-c886-3253-921a-77c43cd50aae"
        }
      ]
    },
    {
      "accessLevel" : [
        {
          "dimID"    : "28484058-4ffc-329b-94ff-63e1ddbd7189",
          "aspectID" : "28484058-4ffc-329b-94ff-63e1ddbd7189"
        },
        {
          "dimID"    : "c689acc7-ee13-3482-aa7b-c6a13419431c",
          "aspectID" : "2b848a8c-c886-3253-921a-77c43cd50aae"
        }
      ]
    },
    {
      "accessLevel" : [
        {
          "dimID"    : "28484058-4ffc-329b-94ff-63e1ddbd7189",
          "aspectID" : "28484058-4ffc-329b-94ff-63e1ddbd7189"
        },
        {
          "dimID"    : "c689acc7-ee13-3482-aa7b-c6a13419431c",
          "aspectID" : "c689acc7-ee13-3482-aa7b-c6a13419431c"
        }
      ]
    }
  ]
}

Response:
HTTP/1.1  200  OK 


  {
    "id": "cb2d8a2d-67e8-40c2-8884-1c77c5ddf251",
    "name":"Special Events",
    "accessSequence" : [
      {
        "accessLevel" : [
          {
            "dimID"      : "28484058-4ffc-329b-94ff-63e1ddbd7189",
            "dimName"    : "SAMPLE_PRODUCTS",
            "aspectID"   : "fbd99ad0-1b92-3baf-8686-772a39e3d065",
            "aspectName" : "UPC"
          },
          {
            "dimID"      : "c689acc7-ee13-3482-aa7b-c6a13419431c",
            "dimName"    : "LARGE_CITIES",
            "aspectID"   : "85921462-8431-3951-97c0-558f7b5f8ffc",
            "aspectName" : "CITY"
          }
        ]
      },
      {
        "accessLevel" : [
          {
            "dimID"      : "28484058-4ffc-329b-94ff-63e1ddbd7189",
            "dimName"    : "SAMPLE_PRODUCTS",
            "aspectID"   : "fbd99ad0-1b92-3baf-8686-772a39e3d065",
            "aspectName" : "UPC"
          },
          {
            "dimID"      : "c689acc7-ee13-3482-aa7b-c6a13419431c",
            "dimName"    : "LARGE_CITIES",
            "aspectID"   : "2b848a8c-c886-3253-921a-77c43cd50aae",
            "aspectName" : "STATE"
          }
        ]
      }
    ],
    "dynamic"   : true,
    "createdBy" : "c3fb23a7-51d5-3f23-aae4-ea3ebcda987f"
  }

Error Example - Update Table to use Dynamic Columns and Static Columns

see: HVS-003701

Request:


  {
    "name":"Special Events",
    "dynamic" : true,
    "columns" : [
      {
        "name" : "Forecasted Volume",
        "dataType" : "DECIMAL",
        "constraints" : [
        {
          "name" : "unitRequired",
          "type" : "BOOLEAN",
          "value" : true
        }],
        "required" : true
      },
      {
        "name" : "Historic Revenue",
        "dataType" : "DECIMAL",
        "constraints" : [
        {
          "name" : "currencyRequired",
          "type" : "BOOLEAN",
          "value" : true
        }],
        "required" : true
      },
      {
        "name" : "Product Cost",
        "dataType" : "DECIMAL",
        "constraints" : [
        {
          "name" : "unitRequired",
          "type" : "BOOLEAN",
          "value" : true
        },
        {
          "name" : "currencyRequired",
          "type" : "BOOLEAN",
          "value" : true
        }],
        "required" : true
      },
      {
        "name" : "Competitor Influence",
        "dataType" : "STRING",
        "required" : false
      }
    ],
    "accessSequence" : [
      {
        "accessLevel" : [
          {
            "dimID"    : "28484058-4ffc-329b-94ff-63e1ddbd7189",
            "aspectID" : "fbd99ad0-1b92-3baf-8686-772a39e3d065"
          },
          {
            "dimID"    : "c689acc7-ee13-3482-aa7b-c6a13419431c",
            "aspectID" : "85921462-8431-3951-97c0-558f7b5f8ffc"
          }
        ]
      },
      {
        "accessLevel" : [
          {
            "dimID"      : "28484058-4ffc-329b-94ff-63e1ddbd7189",
            "aspectID"   : "fbd99ad0-1b92-3baf-8686-772a39e3d065"
          },
          {
            "dimID"      : "c689acc7-ee13-3482-aa7b-c6a13419431c",
            "aspectID"   : "2b848a8c-c886-3253-921a-77c43cd50aae"
          }
        ]
      }
    ]
  }

Response:
HTTP/1.1  400  BAD REQUEST 


  {
      "errorID": "HVS-003701",
      "errorMessage": "\"cb2d8a2d-67e8-40c2-8884-1c77c5ddf251\" cannot be defined to support dynamic columns while also containing specific column configurations.",
      "resourceType": "table",
      "requestID": "8daf08ed-a989-4792-8453-dc51c4127af4"
  }