Hierarchical Value Service API  future
api index

Table Object

since: 0.1
This object contains the metadata of a table. The table can be configured to contain either dynamic data or static data.
  • Dynamic data does not have a set of fixed columns. A table containing dynamic data must not contain any predefined columns.
  • Static data has a set of fixed columns. A table containing static data is required to have column definitions.

Fields

id
0.1required
string
The system-defined internal object ID (in UUID canonical string format).

example value

0a4fa51c-c040-46a0-a3d0-63ca0e9ae699
name
0.1required
string
The name used to identify the table to external systems. It must be unique.

The length constraints are applied to the Unicode Character Representations of the name string.

0.1 min length: 1
0.1 max length: 128
dynamic
0.1optional
boolean
A boolean value indicates if this table is for a set of dynamic data. Dynamic data represents hierarchical values that do not have a set of fixed columns.
0.1 default value: false
createdBy
0.1required
string
The system-defined internal object ID (in UUID canonical string format) to identify the user who created this object.

example value

0a4fa51c-c040-46a0-a3d0-63ca0e9ae699
columns
0.1required
array of ColumnMetadata
A list of metadata of the columns in this table. At least one element is required. Order of the elements are not significant.
0.1 min length: 1
accessSequence
0.1required
array of AccessLevel
A list of access levels in this table. At least one element is required. When searching for an applicable record, the order of the access levels in the list is used as searching order.
0.1 min length: 1
scaleMetadata
0.30optional
ScaleStructure
An optional ScaleStructure describing the scale information used to scale values for the record. Only the metadata for configuring a scale structure is exposed here.

Related API Resources

Example - Example Table Definition

  {
    "id": "e6141291-e16a-4d3d-b1e0-fb2f89767cbb",
    "name": "Price Factors",
    "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",
        "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": [
                {
                    "aspectID": "85921462-8431-3951-97c0-558f7b5f8ffc",
                    "aspectName": "CITY",
                    "dimID": "c689acc7-ee13-3482-aa7b-c6a13419431c",
                    "dimName": "LARGE_CITIES"
                },
                {
                    "aspectID": "fbd99ad0-1b92-3baf-8686-772a39e3d065",
                    "aspectName": "UPC",
                    "dimID": "28484058-4ffc-329b-94ff-63e1ddbd7189",
                    "dimName": "SAMPLE_PRODUCTS"
                }
            ]
        },
        {
            "accessLevel": [
                {
                    "aspectID": "2b848a8c-c886-3253-921a-77c43cd50aae",
                    "aspectName": "STATE",
                    "dimID": "c689acc7-ee13-3482-aa7b-c6a13419431c",
                    "dimName": "LARGE_CITIES"
                },
                {
                    "aspectID": "fbd99ad0-1b92-3baf-8686-772a39e3d065",
                    "aspectName": "UPC",
                    "dimID": "28484058-4ffc-329b-94ff-63e1ddbd7189",
                    "dimName": "SAMPLE_PRODUCTS"
                }
            ]
        },
        {
            "accessLevel": [
                {
                    "aspectID": "fbd99ad0-1b92-3baf-8686-772a39e3d065",
                    "aspectName": "UPC",
                    "dimID": "28484058-4ffc-329b-94ff-63e1ddbd7189",
                    "dimName": "SAMPLE_PRODUCTS"
                }
            ]
        }
    ],
    "scaleMetadata" :
      {
          "type" : "QUANTITY",
          "offsetType": "NUMERIC",
          "calcType" : "GRADUATED"
      }
  }