columnMetaData
Namespace: |
(default namespace) |
XML Schema: |
api.xsd |
ColumnMetaData contains properties to define a column in custom table
JSON Example
{
"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]
},
...
]
}]
}
JSON
property |
type |
description |
name |
name (string)
|
Required field. Must be unique in the same tableDefinition
|
display |
display (string)
|
Display name shown in UI
|
dataType |
dataType (string)
|
Must be one of these data types: timestamp, int, text, real, boolean
|
isKey |
isKey (boolean)
|
Specify if this column is the key of the tableDefinition
|
isVisible |
isVisible (boolean)
|
If false, this column will not be shown in UI. Default is true
|
customProperties |
array of customProperties (customProperty)
|
List of customProperty
|