Hierarchical Value Service API  future
api indexresource index

POST table

since: 0.1
Create a table and specify its metadata.

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
201  CREATED
Error Statuses
400  BAD REQUEST
Other Methods

Example - Create Table Using Dimension Aspect Id

Request:


  {
    "name":"Special Events",
    "columns" : [
      {
        "name" : "Forecasted Volume",
        "dataType" : "DECIMAL",
        "required" : true,
        "constraints" : [
        {
          "name" : "unitRequired",
          "type" : "BOOLEAN",
          "value" : true
        }]
      },
      {
        "name" : "Historic Revenue",
        "dataType" : "DECIMAL",
        "required" : true,
        "constraints" : [
        {
          "name" : "currencyRequired",
          "type" : "BOOLEAN",
          "value" : true
        }]
      },
      {
        "name" : "Product Cost",
        "dataType" : "DECIMAL",
        "required" : true,
        "constraints" : [
        {
          "name" : "unitRequired",
          "type" : "BOOLEAN",
          "value" : true
        },
        {
          "name" : "currencyRequired",
          "type" : "BOOLEAN",
          "value" : 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  201  CREATED 


  {
    "id" : "bb18498a-3228-425a-816c-481bac1030ca",
    "name" : "Special Events",
    "dynamic": false,
    "createdBy" : "496cff4c-2c7e-4a8e-acc5-bf81c4292b3b",
    "columns" : [ 
      {
        "name" : "Forecasted Volume",
        "dataType" : "DECIMAL",
        "constraints" : [
        {
          "name" : "unitRequired",
          "type" : "BOOLEAN",
          "value" : true
        }],
        "required" : true
      },
      {
        "name" : "Historic Revenue",
        "dataType" : "DECIMAL",
        "required" : true,
        "constraints" : [
        {
          "name" : "currencyRequired",
          "type" : "BOOLEAN",
          "value" : true
        }]
      },
      {
        "name" : "Product Cost",
        "dataType" : "DECIMAL",
        "required" : true,
        "constraints" : [
        {
          "name" : "unitRequired",
          "type" : "BOOLEAN",
          "value" : true
        },
        {
          "name" : "currencyRequired",
          "type" : "BOOLEAN",
          "value" : true
        }]
      },
      {
        "name" : "Competitor Influence",
        "dataType" : "STRING",
        "required" : false
      }
    ],
    "accessSequence" : [
      {
        "accessLevel" : [ 
        {
          "aspectID" : "fbd99ad0-1b92-3baf-8686-772a39e3d065",
          "aspectName" : "UPC",
          "dimID" : "28484058-4ffc-329b-94ff-63e1ddbd7189",
          "dimName" : "SAMPLE_PRODUCTS"
        }, 
        {
          "aspectID" : "85921462-8431-3951-97c0-558f7b5f8ffc",
          "aspectName" : "CITY",
          "dimID" : "c689acc7-ee13-3482-aa7b-c6a13419431c",
          "dimName" : "LARGE_CITIES"
        }]
      },
      {
        "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"
        }]
      } 
    ]
  }

Example - Create Table Using Dimension Aspect Name

Request:


  {
    "name":"Promotion Costs",
    "columns" : [
      {
        "name" : "Advertisement",
        "dataType" : "DECIMAL",
        "required" : true,
        "constraints" : [
        {
          "name" : "currencyRequired",
          "type" : "BOOLEAN",
          "value" : true
        }]
      }
    ],
    "accessSequence" : [
      {
        "accessLevel" : [
        {
          "dimName" : "SAMPLE_PRODUCTS",
          "aspectName" : "UPC"
        },
        {
          "dimName" : "LARGE_CITIES",
          "aspectName" : "CITY"
        }]
      }
    ]
  }

Response:
HTTP/1.1  201  CREATED 


  {
    "id" : "cb18498a-3228-425a-816c-481bac1030ca",
    "name" : "Promotion Costs",
    "dynamic": false,
    "createdBy" : "496cff4c-2c7e-4a8e-acc5-bf81c4292b3b",
    "columns" : [ 
      {
        "name" : "Advertisement",
        "dataType" : "DECIMAL",
        "constraints" : [
        {
          "name" : "currencyRequired",
          "type" : "BOOLEAN",
          "value" : true
        }],
        "required" : true
      } 
    ],
    "accessSequence" : [
    {
      "accessLevel" : [ 
        {
          "aspectID" : "fbd99ad0-1b92-3baf-8686-772a39e3d065",
          "aspectName" : "UPC",
          "dimID" : "28484058-4ffc-329b-94ff-63e1ddbd7189",
          "dimName" : "SAMPLE_PRODUCTS"
        }, 
        {
          "aspectID" : "85921462-8431-3951-97c0-558f7b5f8ffc",
          "aspectName" : "CITY",
          "dimID" : "c689acc7-ee13-3482-aa7b-c6a13419431c",
          "dimName" : "LARGE_CITIES"
        } 
      ] 
    }]
  }

Example - Create Table Using Either Id or Name of Dimension and Aspect

Request:


  {
    "name":"Promotion Costs",
    "columns" : [
      {
        "name" : "Advertisement",
        "dataType" : "DECIMAL",
        "required" : true,
        "constraints" : [
        {
          "name" : "currencyRequired",
          "type" : "BOOLEAN",
          "value" : true
        }]
      }
    ],
    "accessSequence" : [ 
      {
        "accessLevel" : [
          {
            "dimName" : "SAMPLE_PRODUCTS",
            "aspectID" : "fbd99ad0-1b92-3baf-8686-772a39e3d065"
          },
          {
            "dimID" : "c689acc7-ee13-3482-aa7b-c6a13419431c",
            "aspectName" : "CITY"
          }
        ]
      }
    ]
  }

Response:
HTTP/1.1  201  CREATED 


  {
    "id" : "cb18498a-3228-425a-816c-481bac1030cb",
    "name" : "Promotion Costs",
    "dynamic": false,
    "createdBy" : "496cff4c-2c7e-4a8e-acc5-bf81c4292b3b",
    "columns" : [ 
      {
        "name" : "Advertisement",
        "dataType" : "DECIMAL",
        "constraints" : [
        {
          "name" : "currencyRequired",
          "type" : "BOOLEAN",
          "value" : true
        }],
        "required" : true
      } 
    ],
    "accessSequence" : [
      {
        "accessLevel" : [ 
          {
            "aspectID" : "fbd99ad0-1b92-3baf-8686-772a39e3d065",
            "aspectName" : "UPC",
            "dimID" : "28484058-4ffc-329b-94ff-63e1ddbd7189",
            "dimName" : "SAMPLE_PRODUCTS"
          }, 
          {
            "aspectID" : "85921462-8431-3951-97c0-558f7b5f8ffc",
            "aspectName" : "CITY",
            "dimID" : "c689acc7-ee13-3482-aa7b-c6a13419431c",
            "dimName" : "LARGE_CITIES"
          } 
        ]
      } 
    ]
  }

Example - Create Table Using Both ID and Name of Dimension or Aspect, The ID Is Used, Name Is Ignored

Request:


  {
    "name":"Very Special Forecasts",
    "columns" : [
      {
        "name"     : "Forecasted Volume",
        "dataType" : "DECIMAL",
        "required" : true
      }
    ],
    "accessSequence" : [
      {
        "accessLevel" : [
          {
            "dimName"    : "SAMPLE_PRODUCTS",
            "aspectName" : "UPC",
            "aspectID"   : "0f025176-fb8b-3536-90ad-8f20f119ed75"
          },
          {
            "dimName"    : "LARGE_CITIES",
            "aspectName" : "CITY"
          }
        ]
      }
    ]
  }

Response:
HTTP/1.1  201  CREATED 


  {
    "id" : "cb18498a-3228-425a-816c-481bac1030cb",
    "name":"Very Special Forecasts",
    "dynamic": false,
    "createdBy" : "496cff4c-2c7e-4a8e-acc5-bf81c4292b3b",
    "columns" : [
      {
        "name"     : "Forecasted Volume",
        "dataType" : "DECIMAL",
        "required" : true
      }
    ],
    "accessSequence" : [
      {
        "accessLevel" : [
          {
            "dimID"      : "28484058-4ffc-329b-94ff-63e1ddbd7189",
            "dimName"    : "SAMPLE_PRODUCTS",
            "aspectID"   : "0f025176-fb8b-3536-90ad-8f20f119ed75",
            "aspectName" : "COMPANY"
          },
          {
            "dimID"      : "c689acc7-ee13-3482-aa7b-c6a13419431c",
            "dimName"    : "LARGE_CITIES",
            "aspectID"   : "85921462-8431-3951-97c0-558f7b5f8ffc",
            "aspectName" : "CITY"
          }
        ]
      }
    ]
  }

Error Example - Create Table Without Payload

see: HVS-003003

Request:


                  Response:
HTTP/1.1 
                  400 
                  BAD REQUEST
               

               

  {
    "errorID"     : "HVS-003003",
    "errorMessage": "Cannot save a table without a valid payload.",
    "resourceType": "table",
    "requestID"   : "d0af9f1b-3159-4212-940e-ce984c19e8d3"
  }

      

            

               
Error
                  Example
                  
                  - Create Table With Wrong Dimension Name

               

                  see: HVS-003022

               
Request:

               

  {
    "name":"Sales Volume",
    "columns" : [
      {
        "name"     : "Forecasted Volume",
        "dataType" : "DECIMAL",
        "required" : true
      }
    ],
    "accessSequence" : [
      {
        "accessLevel" : [
          {
            "dimName"  : "NOT_EXIST_DIMENSION",
            "aspectName" : "UPC"
          }
        ]
      }
    ]
  }

    

                  Response:
HTTP/1.1 
                  400 
                  BAD REQUEST
               

               

  {
    "errorID"     : "HVS-003022",
    "errorMessage": "The dimension NOT_EXIST_DIMENSION was not found.",
    "resourceType": "table",
    "requestID"   : "d0af9f1b-3159-4212-940e-ce984c19e8d4"
  }

      

            

               
Error
                  Example
                  
                  - Create Table With Wrong Dimension ID

               

                  see: HVS-003022

               
Request:

               

  {
    "name":"Sales Volume",
    "columns" : [
      {
        "name"     : "Forecasted Volume",
        "dataType" : "DECIMAL",
        "required" : true
      }
    ],
    "accessSequence" : [
      {
        "accessLevel" : [
          {
            "dimID"  : "00000000-0000-0000-0000-000000000000",
            "aspectName" : "UPC"
          }
        ]
      }
    ]
  }

    

                  Response:
HTTP/1.1 
                  400 
                  BAD REQUEST
               

               

  {
    "errorID"     : "HVS-003022",
    "errorMessage": "The dimension 00000000-0000-0000-0000-000000000000 was not found.",
    "resourceType": "table",
    "requestID"   : "d0af9f1b-3159-4212-940e-ce984c19e8d4"
  }

      

            

               
Error
                  Example
                  
                  - Create Table With Wrong Dimension Aspect Name

               

                  see: HVS-003021

               
Request:

               

  {
    "name":"Sales Volume",
    "columns" : [
      {
        "name"     : "Forecasted Volume",
        "dataType" : "DECIMAL",
        "required" : true
      }
    ],
    "accessSequence" : [
      {
        "accessLevel" : [
          {
            "dimName"  : "SAMPLE_PRODUCTS",
            "aspectName" : "NOT_EXIST_APSECT"
          }
        ]
      }
    ]
  }

    

                  Response:
HTTP/1.1 
                  400 
                  BAD REQUEST
               

               

  {
    "errorID"     : "HVS-003021",
    "errorMessage": "The specified dimension aspect NOT_EXIST_APSECT was not found for dimension: 28484058-4ffc-329b-94ff-63e1ddbd7189.",
    "resourceType": "table",
    "requestID"   : "d0af9f1b-3159-4212-940e-ce984c19e8d4"
  }

      

            

               
Error
                  Example
                  
                  - Create Table With Wrong Dimension Aspect ID

               

                  see: HVS-003021

               
Request:

               

  {
    "name":"Bad Dimension Aspect ID",
    "columns" : [
      {
        "name"     : "Forecasted Volume",
        "dataType" : "DECIMAL",
        "required" : true
      }
    ],
    "accessSequence" : [
      {
        "accessLevel" : [
          {
            "dimName"  : "SAMPLE_PRODUCTS",
            "aspectID" : "00000000-0000-0000-0000-000000000000"
          }
        ]
      }
    ]
  }

    

                  Response:
HTTP/1.1 
                  400 
                  BAD REQUEST
               

               

  {
    "errorID"     : "HVS-003021",
    "errorMessage": "The specified dimension aspect 00000000-0000-0000-0000-000000000000 was not found for dimension: 28484058-4ffc-329b-94ff-63e1ddbd7189.",
    "resourceType": "table",
    "requestID"   : "d0af9f1b-3159-4212-940e-ce984c19e8d4"
  }

      

            

               
Error
                  Example
                  
                  - Create Table With Blank Name or Without a Name

               

                  see: HVS-003001

               
Request:

               

  {
    "name":" ",
    "columns" : [
      {
        "name"     : "Forecasted Volume",
        "dataType" : "DECIMAL",
        "required" : true
      }
    ],
    "accessSequence" : [
      {
        "accessLevel" : [
          {
            "dimName"    : "SAMPLE_PRODUCTS",
            "aspectName" : "UPC"
          },
          {
            "dimName"    : "LARGE_CITIES",
            "aspectName" : "CITY"
          }
        ]
      }
    ]
  }

    

                  Response:
HTTP/1.1 
                  400 
                  BAD REQUEST
               

               

  {
    "errorID": "HVS-003001",
    "errorMessage": "The table name is missing.",
    "resourceType": "table",
    "requestID"   : "d0af9f1b-3159-4212-940e-ce984c19e8d4"
  }

      

            

               
Error
                  Example
                  
                  - Create Table With STRING Column Requires Unit

               

                  see: HVS-003019

               
Request:

               

  {
    "name":"Discount Info",
    "columns" : [
      {
        "name"         : "Discount Reason",
        "dataType"     : "STRING",
        "required"     : true,
        "constraints"  : [
        {
          "name" : "unitRequired",
          "type" : "BOOLEAN",
          "value" : true
        }]
      }
    ],
    "accessSequence" : [
      {
        "accessLevel" : [
          {
            "dimName"    : "SAMPLE_PRODUCTS",
            "aspectName" : "UPC"
          },
          {
            "dimName"    : "LARGE_CITIES",
            "aspectName" : "CITY"
          }
        ]
      }
    ]
  }

    

                  Response:
HTTP/1.1 
                  400 
                  BAD REQUEST
               

               

  {
    "errorID": "HVS-003019",
    "errorMessage": "Unknown constraint to this column type.",
    "resourceType": "table",
    "requestID"   : "d0af9f1b-3159-4212-940e-ce984c19e8d4",
    "details": [
      {
        "fieldID": "Discount Reason",
        "fieldValue": "unitRequired=true"
      }
    ]
  }

      

            

               
Error
                  Example
                  
                  - Create Table With STRING Column Requires Currency

               

                  see: HVS-003019

               
Request:

               

  {
    "name":"Discount Info",
    "columns" : [
      {
        "name"         : "Discount Reason",
        "dataType"     : "STRING",
        "required"     : true,
        "constraints"  : [
        {
          "name" : "currencyRequired",
          "type" : "BOOLEAN",
          "value" : true
        }]
      }
    ],
    "accessSequence" : [
      {
        "accessLevel" : [
          {
            "dimName"    : "SAMPLE_PRODUCTS",
            "aspectName" : "UPC"
          },
          {
            "dimName"    : "LARGE_CITIES",
            "aspectName" : "CITY"
          }
        ]
      }
    ]
  }

    

                  Response:
HTTP/1.1 
                  400 
                  BAD REQUEST
               

               

  {
    "errorID": "HVS-003019",
    "errorMessage": "Unknown constraint to this column type.",
    "resourceType": "table",
    "requestID"   : "d0af9f1b-3159-4212-940e-ce984c19e8d4",
    "details": [
      {
        "fieldID": "Discount Reason",
        "fieldValue": "currencyRequired=true"
      }
    ]
  }

      

            

               
Error
                  Example
                  
                  - Create Table With unknown constraint value type.

               

                  see: HVS-003704

               
Request:

               

  {
    "name":"Discount Info",
    "columns" : [
      {
        "name"         : "Discount",
        "dataType"     : "DECIMAL",
        "required"     : true,
        "constraints"  : [
        {
          "name" : "currencyRequired",
          "type" : "unknown",
          "value" : true
        }]
      }
    ],
    "accessSequence" : [
      {
        "accessLevel" : [
          {
            "dimName"    : "SAMPLE_PRODUCTS",
            "aspectName" : "UPC"
          }
        ]
      }
    ]
  }

    

                  Response:
HTTP/1.1 
                  400 
                  BAD REQUEST
               

               

  {
    "errorID": "HVS-003704",
    "errorMessage": "unknown is not a valid constraint type.",
    "resourceType": "table",
    "requestID"   : "d0af9f1b-3159-4212-940e-ce984c19e8d4"
  }

      

            

               
Error
                  Example
                  
                  - Create Table Boolean Constraint Value Is Invalid

               

                  see: HVS-003018

               
Request:

               

  {
    "name":"Discount Info",
    "columns" : [
      {
        "name"         : "Discount Reason",
        "dataType"     : "STRING",
        "required"     : true,
        "constraints"  : [
        {
          "name" : "unitRequired",
          "type" : "BOOLEAN",
          "value" : "x"
        }
      }
    ],
    "accessSequence" : [
      {
        "accessLevel" : [
          {
            "dimName"    : "SAMPLE_PRODUCTS",
            "aspectName" : "UPC"
          },
          {
            "dimName"    : "LARGE_CITIES",
            "aspectName" : "CITY"
          }
        ]
      }
    ]
  }

    

                  Response:
HTTP/1.1 
                  400 
                  BAD REQUEST
               

               

  {
    "errorID": "HVS-003018",
    "errorMessage": "Boolean constraint must be "true" or "false".",
    "resourceType": "table",
    "requestID"   : "d0af9f1b-3159-4212-940e-ce984c19e8d4",
    "details": [
      {
            "fieldID": "Discount Amt",
            "fieldValue": "unitRequired=x"
      }
    ]
  }

      

            

               
Error
                  Example
                  
                  - Create Table Name Length Is Not Within 1 To 128 Character Range

               

                  see: HVS-003002

               
Request:

               

  {
    "name":"",
    "columns" : [
      {
        "name"         : "Discount Reason",
        "dataType"     : "STRING",
        "required"     : true,
        "constraints"  : [
        {
          "name" : "unitRequired",
          "type" : "BOOLEAN",
          "value" : "x"
        }]
      }
    ],
    "accessSequence" : [
      {
        "accessLevel" : [
          {
            "dimName"    : "SAMPLE_PRODUCTS",
            "aspectName" : "UPC"
          },
          {
            "dimName"    : "LARGE_CITIES",
            "aspectName" : "CITY"
          }
        ]
      }
    ]
  }

    

                  Response:
HTTP/1.1 
                  400 
                  BAD REQUEST
               

               

  {
    "errorID": "HVS-003002",
    "errorMessage": "The length of the table name is invalid.",
    "resourceType": "table",
    "requestID"   : "d0af9f1b-3159-4212-940e-ce984c19e8d4"
  }

      

            

               
Error
                  Example
                  
                  - Create Table No Columns

               

                  see: HVS-003013

               
Request:

               

  {
    "name":"Special Forecasts",
    "accessSequence" : [
      {
        "accessLevel" : [
          {
            "dimName"    : "SAMPLE_PRODUCTS",
            "aspectName" : "UPC"
          },
          {
            "dimName"    : "LARGE_CITIES",
            "aspectName" : "CITY"
          }
        ]
      }
    ]
  }

    

                  Response:
HTTP/1.1 
                  400 
                  BAD REQUEST
               

               

  {
    "errorID": "HVS-003013",
    "errorMessage": "At least one column must be specified for the table.",
    "resourceType": "table",
    "requestID"   : "d0af9f1b-3159-4212-940e-ce984c19e8d4"
  }

      

            

               
Error
                  Example
                  
                  - Create Table Missing Column Name

               

                  see: HVS-003009

               
Request:

               

  {
    "name":"Special Forecasts",
    "columns" : [
      {
        "dataType" : "DECIMAL",
        "required" : true
      }
    ],
    "accessSequence" : [
      {
        "accessLevel" : [
          {
            "dimName"    : "SAMPLE_PRODUCTS",
            "aspectName" : "UPC"
          },
          {
            "dimName"    : "LARGE_CITIES",
            "aspectName" : "CITY"
          }
        ]
      }
    ]
  }

    

                  Response:
HTTP/1.1 
                  400 
                  BAD REQUEST
               

               

  {
    "errorID": "HVS-003009",
    "errorMessage": "The column name is missing.",
    "resourceType": "table",
    "requestID"   : "d0af9f1b-3159-4212-940e-ce984c19e8d4"
  }

      

            

               
Error
                  Example
                  
                  - Create Table Missing Column Type

               

                  see: HVS-003007

               
Request:

               

  {
    "name":"Special Forecasts",
    "columns" : [
      {
        "name" : "Forecasted Volume",
        "required" : true
      }
    ],
    "accessSequence" : [
      {
        "accessLevel" : [
          {
            "dimName"    : "SAMPLE_PRODUCTS",
            "aspectName" : "UPC"
          },
          {
            "dimName"    : "LARGE_CITIES",
            "aspectName" : "CITY"
          }
        ]
      }
    ]
  }

    

                  Response:
HTTP/1.1 
                  400 
                  BAD REQUEST
               

               

  {
    "errorID": "HVS-003007",
    "errorMessage": "The column type must be specified.",
    "resourceType": "table"
    "requestID"   : "d0af9f1b-3159-4212-940e-ce984c19e8d4"
  }

      

            

               
Error
                  Example
                  
                  - Create Table Wrong Column Type

               

                  see: HVS-003008

               
Request:

               

  {
    "name":"Special Forecasts",
    "columns" : [
      {
        "name" : "Forecasted Volume",
        "dataType" : "IllegalType",
        "required" : true
      }
    ],
    "accessSequence" : [
      {
       "accessLevel" : [
          {
            "dimName"    : "SAMPLE_PRODUCTS",
            "aspectName" : "UPC"
          },
          {
            "dimName"    : "LARGE_CITIES",
            "aspectName" : "CITY"
          }
        ]
      }
    ]
  }

    

                  Response:
HTTP/1.1 
                  400 
                  BAD REQUEST
               

               

  {
    "errorID": "HVS-003008",
    "errorMessage": "The type IllegalType is not a valid column type.",
    "resourceType": "table",
    "requestID"   : "d0af9f1b-3159-4212-940e-ce984c19e8d4"
  }

      

            

               
Error
                  Example
                  
                  - Create Table With Empty Columns

               

                  see: HVS-003013

               
Request:

               

  {
    "name":"Special Forecasts",
    "columns" : [
    ],
    "accessSequence" : [
      {
        "accessLevel" : [
          {
            "dimName"    : "SAMPLE_PRODUCTS",
            "aspectName" : "UPC"
          },
          {
            "dimName"    : "LARGE_CITIES",
            "aspectName" : "CITY"
          }
        ]
      }
    ]
  }

    

                  Response:
HTTP/1.1 
                  400 
                  BAD REQUEST
               

               

  {
    "errorID": "HVS-003013",
    "errorMessage": "At least one column must be specified for the table.",
    "resourceType": "table",
    "requestID"   : "d0af9f1b-3159-4212-940e-ce984c19e8d4"
  }

      

            

               
Error
                  Example
                  
                  - Create Table Column Name Length Is Not Within 1 To 128 Character Range

               

                  see: HVS-003006

               
Request:

               

  {
    "name":"Special Forecasts",
    "columns" : [
      {
        "name" : "",
        "dataType" : "DECIMAL",
        "required" : true
      }
    ],
    "accessSequence" : [
      {
        "accessLevel" : [
          {
            "dimName"    : "SAMPLE_PRODUCTS",
            "aspectName" : "UPC"
          },
          {
            "dimName"    : "LARGE_CITIES",
            "aspectName" : "CITY"
          }
        ]
      }
    ]
  }

    

                  Response:
HTTP/1.1 
                  400 
                  BAD REQUEST
               

               

  {
    "errorID": "HVS-003006",
    "errorMessage": "The length of the column name is invalid.",
    "resourceType": "table",
    "requestID"   : "d0af9f1b-3159-4212-940e-ce984c19e8d4"
  }

      

            

               
Error
                  Example
                  
                  - Create Table Access Sequence Is Not Specified

               

                  see: HVS-003014

               
Request:

               

  {
    "name":"Special Forecasts",
    "columns" : [
      {
        "name"     : "Forecasted Volume",
        "dataType" : "DECIMAL",
        "required" : true
      }
    ],
    "accessSequence" : [{
    }]
  }

    

                  Response:
HTTP/1.1 
                  400 
                  BAD REQUEST
               

               

  {
    "errorID": "HVS-003014",
    "errorMessage": "An access sequence must be specified for the table.",
    "resourceType": "table",
    "requestID"   : "d0af9f1b-3159-4212-940e-ce984c19e8d4"
  }

      

            

               
Error
                  Example
                  
                  - Create Table Access Sequence Missing Dimension

               

                  see: HVS-003016

               
Request:

               

  {
    "name":"Special Forecasts",
    "columns" : [
      {
        "name"     : "Forecasted Volume",
        "dataType" : "DECIMAL",
        "required" : true
      }
    ],
    "accessSequence" : [
      {
        "accessLevel" : [
          {
            "aspectID": "fbd99ad0-1b92-3baf-8686-772a39e3d065"
          }
        ]
      }
    ]
  }

    

                  Response:
HTTP/1.1 
                  400 
                  BAD REQUEST
               

               
        
          {
            "errorID": "HVS-003016",
            "errorMessage": "An access sequence entry must contain a dimension name or ID, neither is set.",
            "resourceType": "table",
            "requestID"   : "d0af9f1b-3159-4212-940e-ce984c19e8d4"
          }
        
      

            

               
Error
                  Example
                  
                  - Create Table Access Sequence Missing Dimension Aspect

               

                  see: HVS-003015

               
Request:

               

  {
    "name":"Special Forecasts",
    "columns" : [
      {
        "name"     : "Forecasted Volume",
        "dataType" : "DECIMAL",
        "required" : true
      }
    ],
    "accessSequence" : [
      {
        "accessLevel" : [
          {
            "dimName"    : "SAMPLE_PRODUCTS"
          },
          {
            "dimName"    : "LARGE_CITIES",
            "aspectName" : "CITY"
          }
        ]
      }
    ]
  }

    

                  Response:
HTTP/1.1 
                  400 
                  BAD REQUEST
               

               

  {
    "errorID": "HVS-003015",
    "errorMessage": "A dimension aspect must have an ID or name specified for an entry in the access sequence.",
    "resourceType": "table",
    "requestID"   : "d0af9f1b-3159-4212-940e-ce984c19e8d4"
  }

      

            

               

                  Example
                  
                  - Create Table for Dynamic Data

               
Request:

               
      
      {
        "name"           : "DynamicTable",
        "dynamic"        : true,
        "accessSequence" : [
          {
            "accessLevel" : [
              {
                "dimName"    : "Location",
                "aspectName" : "STATE"
              }
            ]
          }
        ]
      }
      
    

                  Response:
HTTP/1.1 
                  201 
                  CREATED
               

               
        
        {
          "id"             : "bb18498a-3228-425a-816c-481bac1030cd",
          "name"           : "DynamicTable",
          "dynamic"        : true,
          "createdBy"      : "496cff4c-2c7e-4a8e-acc5-bf81c4292b3b",
          "accessSequence" : [
            {
              "accessLevel" : [
                {
                 "dimID"      : "db18498a-3228-425a-816c-481bac1030cd",
                 "dimName"    : "Location",
                 "aspectID"   : "ab18498a-3228-425a-816c-481bac1030cd",
                 "aspectName" : "STATE"
                }
              ]
            }
          ]
        }
        
      

            

               
Error
                  Example
                  
                  - Create Table for Dynamic Data Error on Predefined Columns

               

                  see: HVS-003701

               
Request:

               
      
      {
        "name"            : "DynamicTableWithColumns",
        "columns"         : [
          {
            "name"        : "BaseValue",
            "dataType"    : "DECIMAL",
            "required"    : true
          }
        ],
        "dynamic"        : true,
        "accessSequence" : [
          {
            "accessLevel" : [
              {
                "dimName"    : "Location",
                "aspectName" : "STATE"
              }
            ]
          }
        ]
      }
      
    

                  Response:
HTTP/1.1 
                  400 
                  BAD REQUEST
               

               
        
        {
          "requestID"   : "db18498a-456-123a-816c-481bac1030cd",
          "errorID"     : "HVS-003701",
          "errorMessage": "\"DynamicTableWithColumns\" cannot be defined to support dynamic columns while also containing specific column configurations.",
          "resourceType": "table"
        }