Get form schema version

Retrieves a specific version of a Form's schema using the schema version number.

Request

GET https://www.activityinfo.org/resources/form/{formId}/schema/versions/{version}

Successful response

application/json

object
id	string	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
description	string	A longer description of the field, shown to users during data entry as help text.	optional
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
readOnly	boolean	If true, this field is shown but cannot be edited during data entry. Default is false.	optional
unique	boolean	If true, the value of this field must be unique within the form. Default is false.	optional
type	string	The field type Values: serial A read-only, incrementing serial number for new records. month Stores a month in the ISO-8601 calendar without reference to time-of-day or time-zone. 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
barcode	boolean	For text fields, when true the field is rendered as a barcode-scanner input during data entry.	optional
cardinality	string	For fields of type 'enumerated' or 'attachment', indicates whether single or multiple selection is allowed. Values: SINGLE At most one instance may linked to the field MULTIPLE Any number of instances may be linked to the field	optional
presentation	string	For fields of type 'enumerated', controls how the choices are rendered (automatic, radio_button, or dropdown). Values: AUTOMATIC RADIO_BUTTON DROPDOWN	optional
values	array[object]	For fields of type 'enumerated', the list of valid choices.	optional
id	string	The immutable CUID of this selection item. Must match the format [a-z][a-z0-9]{0,25} and be unique within this field.	required
label	string	Human-readable label for this selection item.	required
range	array[object]	For fields of type 'reference' or 'multiselectreference', the form this field references. Always exactly one entry: the array shape is a legacy of an older version that allowed a single field to reference multiple forms.	optional
formId	string	The id of a form referenced by this entry.	required
lookupConfigs	array[object]	For fields of type 'reference', overrides how referenced records are looked up during data entry. Each entry pairs a formula selecting candidate records with a label.	optional
id	string	Unique id for this lookup configuration	required
formula	string	A formula that will be used to lookup records. It can be a simple field reference, or a more complex formula.	required
lookupLabel	string	A label which describes the lookup. Used in the data entry, table view and other places where the lookup is displayed.	required
formId	string	For fields of type 'subform', the id of the sub form that this field references. For 'reversereference' fields, the id of the form holding the reference field that points back to records of this form.	optional
fieldId	string	For fields of type 'reversereference', the id of the reference field on the form named by 'formId' that points back to records of this form.	optional
formula	string	For fields of type 'calculated', the formula for the field's value.	optional
prefixFormula	string	For fields of type 'serial', a formula whose value becomes the prefix of generated serial numbers.	optional
captureMethods	array[string]	For fields of type 'attachment', the input methods enabled during data entry. Values: FILE SIGNATURE CAMERA	optional
requiredAccuracy	float	For fields of type 'geopoint', the minimum accuracy in meters required when capturing a point from the device's GPS.	optional
indentationLevel	integer	For fields of type 'section' (section headers), the number of levels by which the section header is indented in the form layout.	optional
translationConfig	object	For fields of type 'FREE_TEXT', 'NARRATIVE', or 'calculated', associates this field with a translation field that holds its translations into other languages.	optional
fieldId	string		required
languages	array[string]		required
defaultValue	object	A default value to pre-populate this field with when a new record is created. The structure depends on the field's type.	optional
defaultValueFormula	string	An ActivityInfo formula evaluated when a new record is created; the result becomes the field's default value.	optional

Error responses

Status Code	Error Code	Description
401	AUTHENTICATION_REQUIRED	The request must be authenticated
403	FORBIDDEN	Permission denied
404	NOT_FOUND	The resource could not be found
410	DELETED	The resource has been deleted

Example

curl -u anything:YOUR_API_TOKEN \
  https://www.activityinfo.org/resources/form/ck8pu9ha07/schema/versions/1126

Next item

Get icon