Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Property

Validation

Description

type

Must be string, object, array, number, or boolean

The type of data stored within this field. Matches the types available in JSON-schema

title

String

Title of the field. This is shown in the user interface

multiline

True/False

Whether or not the text-box used for this field will be multi-line. Only app

rows

Number, 1 or greater

The number of text rows the widget should take up if its a multiline text widget

show_in_table_view

True/False

Whether or not this widget should be shown when viewing the data table for this data

table_view_order

Number, 0 or greater

Indicates the order that columns will be disabled in the table view widget in the UI. Lower numbers get placed first, left to right

description

String

The description of the field. This is shown in placeholders on the form widgets, or in subtitles on groups with type: object

placeholder

String

Placeholder text on form inputs. Overrides the description field if provided

form_input_type

Must be text, number, email, phone, address, url, full_name, company_name, checkboxes, datetime, currency, radio, dropdown, string_list, or json

The type of widget that will be used on the user interface in order to edit this field.

required

True/False

Whether or not this field is required to have a value or is allowed to be left empty

options

String List

A list of strings that represent the values of options when using dropdown form input type

optionLabels

String List

A list of strings that represent the titles that will be shown in the user interface for the form input type

default

Any

The default value for this field