- 08 Aug 2024
- 1 Minute to read
- Print
Field types
- Updated on 08 Aug 2024
- 1 Minute to read
- Print
Optional fields are marked with a *
Text
The text field is an ordinary single-line text box:
{
"type": "text",
"key": String,
"caption": String,
"default": String, *
"required": Boolean *
}
Text Area
The textarea field is an ordinary multi-line text box:
{
"type": "text",
"key": String,
"caption": String,
"default": String, *
"required": Boolean *
}
Checkbox
The checkbox field is a simple boolean checkbox or toggle switch.
{
"type": "checkbox",
"key": String,
"caption": String,
"default": Boolean, *
}
Select
The select field type is a list of multiple choices where one option can be selected. (key = value shown in editor and value = property value received by the template).
{
"type": "select",
"key": String,
"caption": String,
"options": [
{ "key": String, "value": String }
],
"default": String, *
"required": Boolean *
}
Content
The content field type is a file picker, where the user can either upload a new file or choose an existing file from the content library.
Default can only be used with predefined contents but path will be created if it does not exist. Note that either content or default is required.
All paths in options are relative to the template's contentBasePath.
{
"type": "content",
"key": String,
"caption": String,
"options": [
{
"path": "backgrounds"
},
{
"content": "logos/store.jpg"
}
],
"default": "logos/store.jpg", *
"defaultId": "xxxxxx", *
"required": Boolean *
}
Contentlist
The contentlist field type is like the content field type, except that it allows the user to select multiple files and control the order of the files:
{
"type": "contentlist",
"key": String,
"caption": String,
"default": [ {"contentId": “xxxxxx” } ],
"options": [
{
"dirid": Integer
},
{
"key": String
},
{
"mediaid": Integer
},
{
"templatefielddataid": Integer
},
{
"templatefieldid": Integer
},
{
"type": String
}
],
}