EntityCreateFieldOptions
User-facing field definition for creating or updating entity schemas
Extends¶
Properties¶
| Property | Type | Description |
|---|---|---|
choiceSetId? |
string |
Choice set ID for choice-set fields |
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) |
fieldName |
string |
Field name — must start with a letter and contain only letters, numbers, and underscores (e.g., "productName"). |
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) |
referenceEntityId? |
string |
UUID of the referenced entity (required when type is RELATIONSHIP; ignored for FILE). |
referenceFieldId? |
string |
UUID of the referenced field on the target entity (required when type is RELATIONSHIP; ignored for FILE). |
referenceFolderKey? |
string |
Experimental Folder key of the reference target when it lives outside the source's folder. Pass '00000000-0000-0000-0000-000000000000' for tenant-level system targets. Folder-scoped Data Fabric is in preview — the contract may change. |
type? |
EntityFieldDataType |
Field data type — one of the EntityFieldDataType values (default: STRING) |