The immutable CUID for this form. Must be globally unique within an ActivityInfo server
required
label
string
A human-readable label for this form
required
schemaVersion
string
A monotonically increasing version number of this schema assigned by the server upon updates
required
databaseId
string
The id of the database to which this form belongs
required
parentFormId
string
The id of this form's parent, if this form is a subform. Note that subforms can only be created by adding a subform field to the parent form.
optional
elements
array[object]
This form's fields, section headers, and other elements.
required
id
string
An immutable CUID for this field that is unique within the form
required
code
string
A developer-friendly code for this field that can be used in formulas and in the API. Must match the pattern ^[A-Za-z][A-Za-z0-9_]*
optional
label
string
A short human-friendly label for this field
required
relevanceCondition
string
A boolean-valued ActivityInfo formula that determines when this field is 'relevant'. Fields that are not relevant are not displayed during data entry and must be blank.
optional
validationCondition
string
A boolean-valued ActivityInfo formula that determines when this field's value is valid.
optional
dataEntryVisible
boolean
If false, this field is not shown in data entry
optional
tableVisible
boolean
If false, this field is not shown by default in the table view
optional
required
boolean
If true, a value for this field must be provided
required
key
boolean
If true, this field is part of the form's natural key fields whose combination must be unique within the form
required
type
string
The field type Values:
serial
A read-only, incrementing serial number for new records.
month
The Serial Number field type provides a readable, incrementing serial number for new records.
attachment
Stores one or more files, which can include photos, signatures, documents, PDFs or any other type of file.
geopoint
Stores a point within the WGS84 Geographic Reference System
FREE_TEXT
Stores a single line of Unicode text
quantity
Stores a real-valued number as a floating point
enumerated
Gives users a choice between a list of predefined values
multiselectreference
Stores a reference to one or more records in another form
epiweek
Stores a year and week number.
subform
Defines a reference to another form that plays a child role to this parent form.
date
Stores a date in the ISO-8601 calendar without reference to time-of-day or time-zone.
calculated
A read-only field whose value is always calculated from a formula
reversereference
Defines a reverse link from a referenced form back to this form.
reference
Stores a reference to one record in another form
fortnight
Stores a two-week period using year and a week number, where the week number must be odd. [Deprecated]
section
Defines a section header that helps organize a form. Does not have a field value.
NARRATIVE
Stores multiple lines of Unicode text
required
securityCategoryId
string
optional
typeParameters
object
Additional type-specific properties of this field.
optional
units
string
For fields of type 'quantity', describes the units of the quantity
optional
inputMask
string
For text fields, provides a pattern-based input mask
optional
cardinality
string
For fields of type 'enumerated', indicates whether single or multiple select. Values:
SINGLE
At most one instance may linked to the field
MULTIPLE
Any number of instances may be linked to the field
optional
range
object
For fields of type 'reference', provides the id of the form that this field references
optional
formId
string
For fields of type 'subform', provides the id of the sub form that this field references
optional
items
array[object]
For fields of type 'enumerated', provided the list of valid choices
optional
id
string
The immutable id of this selection item. Must match the format [a-z][a-z0-9]{0,25}
required
label
string
Human-readable label for this selection item.
required
formula
string
For fields of type 'calculated', provides the formula for the field's value
optional
prefixFormula
string
For fields of type 'serial', provides a formula that will be used to compute the prefix of the generated serial number.