Value Data Types
The dataType property of a Value Type determines what kind of value the field stores and how it is displayed and validated.
The default data type is TEXT if dataType is omitted.
Text
| Type | Description |
|---|---|
TEXT | A single-line text string. Default type. |
TEXTBLOCK | Multi-line rich text (HTML). |
MULTILINGUAL | A text value with per-language variants. |
EMAIL | An email address. Validated on input. |
HYPERLINK | A URL. Displayed as a clickable link. |
Numbers
| Type | Description |
|---|---|
INTEGER | A whole number. |
DECIMAL | A decimal number. |
CURRENCY | A monetary amount. Displayed with currency symbol. |
PERCENTAGE | A percentage value. Displayed with %. |
Boolean
| Type | Description |
|---|---|
BOOLEAN | True or false. Displayed as a checkbox. |
Date and time
| Type | Description |
|---|---|
DATE | A calendar date (year, month, day). |
DATETIME | A date with time of day. |
TIME | A time of day without date. |
Files
| Type | Description |
|---|---|
FILE | A file attachment. |
IMAGE | An image file. Displayed as a preview. |
Lists
| Type | Description |
|---|---|
LIST | A value from a predefined list. Requires the list property pointing to a StandardList TypeFQN. |
ARRAY | An ordered list of values. |
Example
{
"valueTypes": [
{ "name": "firstName" },
{ "name": "lastName", "required": true },
{ "name": "emailAddress", "dataType": "EMAIL" },
{ "name": "birthdate", "dataType": "DATE", "enabled": false },
{ "name": "salary", "dataType": "CURRENCY" },
{ "name": "isActive", "dataType": "BOOLEAN" },
{ "name": "status", "dataType": "LIST", "list": "my-project.contractStatus" },
{ "name": "notes", "dataType": "TEXTBLOCK" }
]
}