Skip to main content

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

TypeDescription
TEXTA single-line text string. Default type.
TEXTBLOCKMulti-line rich text (HTML).
MULTILINGUALA text value with per-language variants.
EMAILAn email address. Validated on input.
HYPERLINKA URL. Displayed as a clickable link.

Numbers

TypeDescription
INTEGERA whole number.
DECIMALA decimal number.
CURRENCYA monetary amount. Displayed with currency symbol.
PERCENTAGEA percentage value. Displayed with %.

Boolean

TypeDescription
BOOLEANTrue or false. Displayed as a checkbox.

Date and time

TypeDescription
DATEA calendar date (year, month, day).
DATETIMEA date with time of day.
TIMEA time of day without date.

Files

TypeDescription
FILEA file attachment.
IMAGEAn image file. Displayed as a preview.

Lists

TypeDescription
LISTA value from a predefined list. Requires the list property pointing to a StandardList TypeFQN.
ARRAYAn 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" }
]
}