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.

List Form Field Sets

SDK Method

Files::FormFieldSet.list

Return Object

List<FormFieldSet>

Authorization Requirement

Available to all authenticated keys or sessions.

Method Arguments

ArgumentDescription
user_id
int64		User ID. Provide a value of 0 to operate the current session's user.

Additional Arguments

Example Request

begin
  form_field_sets = Files::FormFieldSet.list(
    user_id: 1
  )
  form_field_sets.auto_paging_each do |form_field_set|
    # Operate on form_field_set
  end
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

Show Form Field Set

SDK Method

Files::FormFieldSet.find

Return Object

FormFieldSet

Authorization Requirement

Available to all authenticated keys or sessions.

Method Arguments

ArgumentDescription
id
int64
Required		Form Field Set ID.

Example Request

begin
  form_field_set = Files::FormFieldSet.find(id)
  # Operate on form_field_set
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

Create Form Field Set

SDK Method

Files::FormFieldSet.create

Return Object

FormFieldSet

Authorization Requirement

Available to all authenticated keys or sessions.

Method Arguments

ArgumentDescription
user_id
int64		User ID. Provide a value of 0 to operate the current session's user.
title
string		Title to be displayed
workspace_id
int64		Workspace ID
skip_email
boolean		Skip validating form email
skip_name
boolean		Skip validating form name
skip_company
boolean		Skip validating company
form_fields
array(object)

Example Request

begin
  form_field_set = Files::FormFieldSet.create(
    user_id: 1
  )
  # Operate on form_field_set
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

Update Form Field Set

SDK Method

form_field_set.update

Return Object

FormFieldSet

Authorization Requirement

Available to all authenticated keys or sessions.

Method Arguments

ArgumentDescription
title
string		Title to be displayed
workspace_id
int64		Workspace ID
skip_email
boolean		Skip validating form email
skip_name
boolean		Skip validating form name
skip_company
boolean		Skip validating company
form_fields
array(object)

Example Request

begin
  # Find the form_field_set object by its id.
  form_field_set = Files::FormFieldSet.find(id)
  form_field_set.update(
    title: "Sample Form Title"
  )
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

Delete Form Field Set

SDK Method

form_field_set.delete

Return Object

nil

Authorization Requirement

Available to all authenticated keys or sessions.

Example Request

begin
  # Find the form_field_set object by its id.
  form_field_set = Files::FormFieldSet.find(id)
  form_field_set.delete
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

The FormFieldSet Object

Some of the methods above return a FormFieldSet object. The attributes of this object are listed below.

AttributeDescription
id
int64		Form field set id
title
string		Title to be displayed
form_layout
array(int64)		Layout of the form
form_fields
array(object)		Associated form fields
skip_name
boolean		Any associated InboxRegistrations or BundleRegistrations can be saved without providing name
skip_email
boolean		Any associated InboxRegistrations or BundleRegistrations can be saved without providing email
skip_company
boolean		Any associated InboxRegistrations or BundleRegistrations can be saved without providing company
in_use
boolean		Form Field Set is in use by an active Inbox / Bundle / Inbox Registration / Bundle Registration