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

Command

files-cli form-field-sets list

Output

Outputs a list of FormFieldSet objects according to the output format.

Authorization Requirement

Available to all authenticated keys or sessions.

Flags

FlagDescription
--user-id=
int64		User ID. Provide a value of 0 to operate the current session's user.

Additional Arguments

Example Request

files-cli form-field-sets list \
  --user-id=1

Show Form Field Set

Command

files-cli form-field-sets find

Output

Outputs a FormFieldSet object according to the output format.

Authorization Requirement

Available to all authenticated keys or sessions.

Flags

FlagDescription
--id=
int64
Required		Form Field Set ID.

Example Request

files-cli form-field-sets find \
  --id=1

Create Form Field Set

Command

files-cli form-field-sets create

Output

Outputs a FormFieldSet object according to the output format.

Authorization Requirement

Available to all authenticated keys or sessions.

Flags

FlagDescription
--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

files-cli form-field-sets create \
  --user-id=1

Update Form Field Set

Command

files-cli form-field-sets update

Output

Outputs a FormFieldSet object according to the output format.

Authorization Requirement

Available to all authenticated keys or sessions.

Flags

FlagDescription
--id=
int64
Required		Form Field Set ID.
--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

files-cli form-field-sets update \
  --id=1 \
  --title="Sample Form Title"

Delete Form Field Set

Command

files-cli form-field-sets delete

Output

No output is returned.

Authorization Requirement

Available to all authenticated keys or sessions.

Flags

FlagDescription
--id=
int64
Required		Form Field Set ID.

Example Request

files-cli form-field-sets delete \
  --id=1

The FormFieldSet Object

Some of the commands 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