tableDefinition

Namespace: (default namespace)
XML Schema: api.xsd

Table definition contains properties that define a new custom table.

JSON Example


 {
  "name": [table name],
  "display" : [table display name],
  "columnsMetaData": [
   {
    "name" : [column name],
    "display" : [display name],
    "dataType" : [timestamp|int|text|real|boolean],
    "isKey" : [true|false],
    "isVisible" : [true|false],   (Optional:Default is true)
    "customProperties": [
     {
      "name": [name],
      "value": [value]
     },
     ...
    ]
   },
   ...
  ],
  "seriesMetaData": [
   {
    "name" : [series name],
    "display" : [display name],
    "freq" : [LF|HF],
    "dataType" : [timestamp|int|text|bigtext|real|boolean],
    "isVisible" : [true|false],     (Optional:Default is true)
    "customProperties": [
     {
      "name": [name],
      "value": [value]
     },
     ...
    ]
   },
   ...
  ]
 }

JSON

property type description
name name (string) Name of the custom table
display display (string) Custom table display name shown in UI
columnsMetaData array of columnsMetaData (columnMetaData) List of columns defined in the custom table
seriesMetaData array of seriesMetaData (seriesMetaData) List of time series columns defined in the custom table