Skip to content

EntityFieldDataType

Entity field data type names (SQL-level types returned by the API)

Enumeration Members

AUTO_NUMBER

AUTO_NUMBER: "AUTO_NUMBER"


BIG_INTEGER

BIG_INTEGER: "BIG_INTEGER"


BOOLEAN

BOOLEAN: "BOOLEAN"


CHOICE_SET_MULTIPLE

CHOICE_SET_MULTIPLE: "CHOICE_SET_MULTIPLE"


CHOICE_SET_SINGLE

CHOICE_SET_SINGLE: "CHOICE_SET_SINGLE"


DATE

DATE: "DATE"


DATETIME

DATETIME: "DATETIME"


DATETIME_WITH_TZ

DATETIME_WITH_TZ: "DATETIME_WITH_TZ"


DECIMAL

DECIMAL: "DECIMAL"


DOUBLE

DOUBLE: "DOUBLE"


FILE

FILE: "FILE"


FLOAT

FLOAT: "FLOAT"


INTEGER

INTEGER: "INTEGER"


MULTILINE_MAX

MULTILINE_MAX: "MULTILINE_MAX"

Large multi-line text, up to a 128 KB byte budget (about 65,536 characters). The Multi-line (Max) feature must be enabled for the tenant, otherwise creating the field or adding it to an existing entity is rejected.

Reads are not uniform, and only a single-record read by ID is guaranteed to return the whole value. List and query return a bounded preview: the value itself when it is at most 10,000 characters, its first 10,000 characters followed by "...[Truncated]" when longer, or a size marker starting "HasValue=true Length=N", sometimes with a trailing hint. Which of those a tenant returns depends on its rollout state, so treat a preview as opaque: do not parse or compare it, and never write it back, since that replaces the stored value with the preview. An encrypted field always returns the marker "HasValue=true Encrypted=true" and never content, on any tenant.

The key is absent rather than null whenever there is no value to return: a null value on any read, a join query, and insert/update responses. The field cannot be used in filterGroup, sortOptions, or a join condition; those requests are rejected.


MULTILINE_TEXT

MULTILINE_TEXT: "MULTILINE_TEXT"


RELATIONSHIP

RELATIONSHIP: "RELATIONSHIP"


STRING

STRING: "STRING"


UUID

UUID: "UUID"