Skip to content

EntityFieldBase

Common field properties shared across field definition and update types

Extended by

Properties

Property Type Description
decimalPrecision? number Number of decimal places for DECIMAL, FLOAT, and DOUBLE fields (default: 2, range: 0–10)
defaultValue? string Default value for the field
description? string Optional field description
displayName? string Human-readable display name shown in the UI (defaults to name if omitted)
isEncrypted? boolean Whether the field value is encrypted at rest (default: false)
isHiddenField? boolean Whether the field is hidden from the UI (default: false)
isRbacEnabled? boolean Whether role-based access control is enabled for this field (default: false)
isRequired? boolean Whether the field is required (default: false)
isUnique? boolean Whether the field value must be unique across records (default: false)
lengthLimit? number Maximum character length for STRING fields (default: 200, range: 1–4000) and MULTILINE_TEXT fields (default: 200, range: 1–10000).
maxValue? number Maximum allowed value for numeric fields (INTEGER, BIG_INTEGER, FLOAT, DOUBLE, DECIMAL — default: 1,000,000,000,000; range: ±9,007,199,254,740,991)
minValue? number Minimum allowed value for numeric fields (INTEGER, BIG_INTEGER, FLOAT, DOUBLE, DECIMAL — default: -1,000,000,000,000; range: ±9,007,199,254,740,991)