Form Field Sets

A Form Field Set is a custom form to be used for bundle and inbox registrations.

Each Form Field Set contains one or more Form Fields. A form and all of its form fields are submitted in a single create request. The order of form fields in the array is the order they will be displayed.

Once created, a form field set can then be associated with one or more bundle(s) and/or inbox(s). Once associated, you will be required to submit well-formatted form-data when creating a bundle-registration or inbox registration.

Resource Schema

Optional

Property	Description
title String	Title to be displayed
form_fields Dynamic	Associated form fields
skip_name Bool	Any associated InboxRegistrations or BundleRegistrations can be saved without providing name
skip_email Bool	Any associated InboxRegistrations or BundleRegistrations can be saved without providing email
skip_company Bool	Any associated InboxRegistrations or BundleRegistrations can be saved without providing company
user_id Int64	User ID. Provide a value of `0` to operate the current session's user.
workspace_id Int64	Workspace ID

Read Only

Property	Description
id Int64	Form field set id
form_layout List	Layout of the form
in_use Bool	Form Field Set is in use by an active Inbox / Bundle / Inbox Registration / Bundle Registration

Example Resource

resource "files_form_field_set" "example_form_field_set" {
  user_id      = 1
  title        = "Sample Form Title"
  workspace_id = 1
  skip_email   = false
  skip_name    = false
  skip_company = false
  form_fields  = [
    {
      label              = "Sample Label"
      required           = true
      help_text          = "Help Text"
      field_type         = "text"
      options_for_select = ["red", "green", "blue"]
      default_option     = "red"
      form_field_set_id  = 1
    }
  ]
}

Resource Import

This Resource supports importing using the following syntax:

Example Import Command

# Form Field Sets can be imported by specifying the id.
terraform import files_form_field_set.example_form_field_set 1

Data Source Schema

Required

Property	Description
id Int64	Form field set id

Read Only

Property	Description
title String	Title to be displayed
form_layout List	Layout of the form
form_fields Dynamic	Associated form fields
skip_name Bool	Any associated InboxRegistrations or BundleRegistrations can be saved without providing name
skip_email Bool	Any associated InboxRegistrations or BundleRegistrations can be saved without providing email
skip_company Bool	Any associated InboxRegistrations or BundleRegistrations can be saved without providing company
in_use Bool	Form Field Set is in use by an active Inbox / Bundle / Inbox Registration / Bundle Registration

Example Data Source

data "files_form_field_set" "example_form_field_set" {
  id = 1
}