INTERFACE

OnlineFormFieldInterface

Question of an online form; the answer is stored in a field of the record the response creates or updates.

link GraphQL Schema definition

  • interface OnlineFormFieldInterface {
  • # Identifier of the entity field this form field captures.
  • fieldId: String!
  • # Label shown above the field on the form.
  • name: String!
  • # Help text shown under the field label on the form.
  • description: String!
  • # If true, an image is displayed alongside the field.
  • imageEnabled: Boolean!
  • # Cloud storage identifier of the image displayed with the field.
  • imageCloudObjectId: ID
  • # If true, the field is shown on the form.
  • visible: Boolean!
  • # If true, the field must be filled in before the form can be submitted.
  • required: Boolean!
  • # If true, the field is displayed but cannot be edited by the respondent.
  • readOnly: Boolean!
  • # If true, the field is pre-populated with a value when the form loads.
  • prefillEnabled: Boolean!
  • # Source of the prefill value: Custom for a fixed value, Field to copy from
  • # another field.
  • prefillType: OnlineFormPrefillTypeEnum!
  • # Identifier of the field whose value is copied in when prefill type is Field.
  • prefillFieldId: String
  • # Identifier of the lookup field used to resolve the prefill value when prefilling
  • # from a related record.
  • prefillLookupFieldId: ID
  • # Filter conditions that control whether the field is shown, based on the values
  • # of other fields.
  • conditionalRulesFilter: FieldFilter
  • }

link Require by