Hierarchical Value Service API  future
api index

ColumnMetadata Object

since: 0.1
This object is the metadata of a column in a table.

Fields

name
0.1required
string
The name used to identify the column to external systems. It must be unique within a table.

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

0.1 min length: 1
0.1 max length: 128
dataType
0.1required
string
The system supported data type of the column.
0.1 valid values:
  • STRING
  • DECIMAL

example value

DECIMAL
isRequired
0.1optional
boolean
Whether this column is required to be present in the record.
0.1 default value: false
constraints
0.1optional
string
Optional set of Constraint objects to specify special requirements of a column.

Related API Objects

Example - Example Column Metadata

    {
        "name": "Forecasted Volume",
        "dataType": "DECIMAL",
        "constraints": [
          {
            "name" : "unitRequired",
            "type" : "BOOLEAN",
            "value": true
          },
          {
            "name" : "currencyRequired",
            "type" : "BOOLEAN",
            "value": true,
          }
        ],
        "required": true
    }