Hierarchical Value Service API  future
api index

Column Object

since: 0.1
Represents the value of a column in a record.

Fields

name
0.1required
string
The name of the column in the record. It must match one of the columns defined in the related table.
type
0.1optional
string
The data type of the value.

When setting a value, this field is required if the table is marked as dynamic. If the table is marked as static, then this field will be ignored if provided, and the data type will be determined from the table metadata.

0.1 valid values:
  • STRING
  • DECIMAL

example value

DECIMAL
value
0.1required
string
The column value represented in string format.

example values

  • 2.03
  • This is the reason why my type is STRING.
unit
0.1optional
string
The unit of this value. If the column metadata has a constraint that requires a unit, this field is required.

example values

  • METER
  • POUND
currency
0.1optional
string
The currency used by this value. If the column metadata has a constraint that requires a currency, this field is required.

example values

  • USD
  • CNY
perQuantity
0.1optional
string
The per quantity (scale factor) used with this value. If unit is not supplied, this value can only be set to 0. If unit is supplied without currency supplied, this value can only be set to 1. If both unit and currency are supplied, any non-integral positive number between .00000001 (1e-8) to 99,999,999 (1e8 - 1) inclusive.

example values

  • 1
  • 0.5

Related API Objects

Example - Example Record Column

    {
      "name": "Price",
      "value": "20",
      "type": "DECIMAL",
      "unit": "foot",
      "currency": "USD",
      "perQuantity" : 1
    }