_id (Primary Key)
objectid
The unique identifier for the record
| Requires a Non-Null Value | Yes |
key Field Key
string
The key that will be used for the form field when submitting to the server.
| Requires a Non-Null Value | Yes |
| Default Value | "" |
| Trims Whitespace | No |
| HTML Tags Allowed | No |
| Converts to Lowercase | No |
| Converts to Uppercase | No |
dataType Operator
options
The type of form field for this input
| Requires a Non-Null Value | Yes |
| Allowed Values | | text | A short-form text input field. | | text:long | A long-form text input field. | | boolean | A checkbox that can be set to on or off. | | time:datetime | A date and time selection form field. | | hidden | A hidden form field with a preset value. | | text:password | A password form field with the input value obscured for security. | | file | A file upload form field. | | profile | A selector for a consumer profile used for authentication. |
|
| Default Value | text |
defaultValue Default Value
string
The initial / default value for the form field.
| Requires a Non-Null Value | Yes |
| Default Value | "" |
| Trims Whitespace | No |
| HTML Tags Allowed | No |
| Converts to Lowercase | No |
| Converts to Uppercase | No |
label Label
string
A label for the form field that will be included in the form.
| Requires a Non-Null Value | Yes |
| Default Value | "" |
| Trims Whitespace | No |
| HTML Tags Allowed | No |
| Converts to Lowercase | No |
| Converts to Uppercase | No |
isRequired Required
boolean
When active, the form will not be allowed to be permitted if no input has been received for this form field.
| Requires a Non-Null Value | Yes |
| Default Value | No |
documentation Parameter Documentation
string
Utilized when generating documentation for the endpoint. HTML is permitted.
| Requires a Non-Null Value | Yes |
| Default Value | "" |
| Trims Whitespace | No |
| HTML Tags Allowed | Yes |
| Converts to Lowercase | No |
| Converts to Uppercase | No |
priority
integer
| Requires a Non-Null Value | Yes |
| Default Value | 0 |
parentProcess Parent Process
objectid
A reference to the process that owns this form field record.
| Requires a Non-Null Value | No |
projectId
objectid
A reference to the project that owns this form field record.
| Requires a Non-Null Value | Yes |
accountId
objectid
A reference to the account that owns this form field record.
| Requires a Non-Null Value | Yes |
createdTime
datetime
System managed property. Set to the timestamp of when the record is created.
| Requires a Non-Null Value | Yes |
| Default Value | __auto__ |
modifiedTime
datetime
System managed property. Set to the timestamp of when the record is updated.
| Requires a Non-Null Value | Yes |
| Default Value | __auto__ |