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.

  • value
    Type: string
    required

    The field value as a string; the actual storage column (valueInt, valueFloat, valueDatetime, valueWysiwyg) used internally is determined by the field's inputType. For inputType calculation and rollup this value is computed by the system and read-only — see the schema description.

  • created
    Type: string Format: date-time
    read-only

    Creation datetime

  • customFieldInputId
    Type: integer

    Field id. If this field is not specified, ID is loaded using customFieldInputName and module

  • customFieldInputName
    Type: string

    Name of field which gets filled. Applied only when customFieldInputId is not set

  • entityId
    Type: integer

    ID of the record (within the given module) that this value is attached to.

  • fileId
    Type: integer

    ID of the uploaded file; used when the field inputType is 'file'.

  • id
    Type: integer
    read-only

    Unique identifier of this field value record.

  • ipAddress
    Type: string

    IP address from which this value was submitted; used for GDPR, newsletter, and cookie acceptance inputs.

  • module
    Type: string · All modules in system (dash syntax)

    Module this field value belongs to

    Module name in kebab-case (dash-separated) format, used in URL path parameters. Open set (built-ins plus custom modules); not restricted to an enum.

  • selected
    Type: boolean

    TRUE if this value is selected (used for checkboxes and radio sets)

  • table
    Type: string

    Module table (if module has more tables). If not filled, is loaded automatically

  • translatable
    Type: boolean

    Is field translatable

  • translations
    Type: object · TranslationLanguage
    • propertyName
      Type: object
  • valueDatetime
    Type: string Format: date-time
    read-only

    Input value, stored as Datetime (inner db representation of DATETIME value

  • valueFloat
    Type: number Format: float
    read-only

    Input value, stored as Float (inner db representation of DOUBLE value

  • valueInt
    Type: integer
    read-only

    Input value, stored as Integer (inner db representation of INT value

  • valueModule
    Type: string

    Module of connected entity. It's only for values from connected-value fields.

  • valueWysiwyg
    Type: string
    read-only

    Input value, stored as Wysiwig (inner db representation of TEXT value)