FieldValue
A single custom field value attached to a record. The field is identified either by customFieldInputId, or by customFieldInputName + module. Values of computed fields (inputType calculation and rollup) are read-only: a calculation value is evaluated at read time from the field's inputCalculation formula and never stored, a rollup value is recomputed automatically from related records; writes to either are ignored.
- valuerequired
The field value. Its JSON type follows the field's inputType:
numberreturns an integer;float,moneyandpercentreturn a number;checkboxreturns a boolean;fileandimagereturn the integer id of the uploaded file;date,datetime,gdpr_accept,newsletter_acceptandcookies_acceptreturn a formatted date string;ratingreturns the picked number as a string;selectandradioreturn the option value, never its label (the label is exposed inselected);multiselectandcheckbox_groupreturn the picked option values joined by a pipe, e.g. new|qualified;related_entityreturns the id of the linked record as a string, its module being reported invalueModule;related_entitiesreturns the ids of the linked records joined by a pipe, e.g. 1|2|3;usersreturns a JSON-encoded string — not an object — whose decoded shape carries the keysusers,teamsandcategories, each an array of integer ids;calculationreturns whatever the formula evaluates to, i.e. a string, a number or a boolean;rollupreturns an array of the collected values for SHOW_ORIGINAL and SHOW_UNIQUE, a number or a date string for scalar aggregations, or an object carrying a single_errorkey when the aggregation fails; every other inputType returns a string. Writes accept the same shapes, but only as JSON scalars: an array or an object invalueis rejected with code 4006, sousersandrelated_entitieshave to be sent in the string forms above (arelated_entitiesvalue that is neither pipe-separated nor a single numeric id is rejected with code 4017). Custom field values nested in a Space are serialised through a separate string-cast path, so there every inputType —numberandcheckboxincluded — comes back as a string. The storage column used internally (valueInt, valueFloat, valueDatetime, valueWysiwyg) is determined by the same inputType. For inputTypecalculationandrollupthis value is computed by the system and read-only — see the schema description.- Type: string
The field value. Its JSON type follows the field's inputType:
numberreturns an integer;float,moneyandpercentreturn a number;checkboxreturns a boolean;fileandimagereturn the integer id of the uploaded file;date,datetime,gdpr_accept,newsletter_acceptandcookies_acceptreturn a formatted date string;ratingreturns the picked number as a string;selectandradioreturn the option value, never its label (the label is exposed inselected);multiselectandcheckbox_groupreturn the picked option values joined by a pipe, e.g. new|qualified;related_entityreturns the id of the linked record as a string, its module being reported invalueModule;related_entitiesreturns the ids of the linked records joined by a pipe, e.g. 1|2|3;usersreturns a JSON-encoded string — not an object — whose decoded shape carries the keysusers,teamsandcategories, each an array of integer ids;calculationreturns whatever the formula evaluates to, i.e. a string, a number or a boolean;rollupreturns an array of the collected values for SHOW_ORIGINAL and SHOW_UNIQUE, a number or a date string for scalar aggregations, or an object carrying a single_errorkey when the aggregation fails; every other inputType returns a string. Writes accept the same shapes, but only as JSON scalars: an array or an object invalueis rejected with code 4006, sousersandrelated_entitieshave to be sent in the string forms above (arelated_entitiesvalue that is neither pipe-separated nor a single numeric id is rejected with code 4017). Custom field values nested in a Space are serialised through a separate string-cast path, so there every inputType —numberandcheckboxincluded — comes back as a string. The storage column used internally (valueInt, valueFloat, valueDatetime, valueWysiwyg) is determined by the same inputType. For inputTypecalculationandrollupthis value is computed by the system and read-only — see the schema description.
- createdType: string Format: date-timeread-only
Creation datetime
- customType: integer
Field Input Id Field id. If this field is not specified, ID is loaded using
customFieldInputNameandmodule - customType: string
Field Input Name Name of field which gets filled. Applied only when
customFieldInputIdis not set - entityType: integer
Id ID of the record (within the given module) that this value is attached to.
- fileType: integer
Id ID of the uploaded file; used when the field inputType is 'file'.
- idType: integerread-only
Unique identifier of this field value record.
- ipType: string
Address IP address from which this value was submitted; used for GDPR, newsletter, and cookie acceptance inputs.
- moduleType: string · All modules in system (dash syntax)
Module this field value belongs to
- selectedType: string | null
Label of the option picked for this value, resolved by matching the whole stored
valueagainst the option values of the field. Filled for the option-based inputTypes —select,multiselectandradio— and null for every other inputType, includingcheckbox, whose state is carried byvalueas a boolean, andcheckbox_group. Because the match runs against the whole stored value, amultiselectholding several pipe-joined options resolves to null; only a single picked option yields a label. This property therefore never carries a list of labels — to get the labels of several picked options, splitvalueon the pipe and map the option values against the field options. - tableType: string
Module table (if module has more tables). If not filled, is loaded automatically
- translatableType: boolean
Is field translatable
- translationsType: object · TranslationLanguage
- propertyType: object
Name
- valueType: string Format: date-time
Datetime read-onlyInput value, stored as Datetime (inner db representation of DATETIME value
- valueType: number Format: float
Float read-onlyInput value, stored as Float (inner db representation of DOUBLE value
- valueType: integer
Int read-onlyInput value, stored as Integer (inner db representation of INT value
- valueType: string
Module Module of connected entity. It's only for values from connected-value fields.
- valueType: string
Wysiwyg read-onlyInput value, stored as Wysiwig (inner db representation of TEXT value)