Schemas

ContentType

Content type is a generic term indicating a definition of a class of content items. Document types and FieldGroup types are all content types. See official documentation

Properties

propertyrequiredtypedescriptiondetailsexample
nameYstringidentifying name of this Content type. Unless the content type belongs to the default group ('brxsaas'), the name must be prefixed with the group name and the colon character, e.g. 'mygroup:mytype  
enabled booleanwhether the content type is available for authors and editors to create new documents and pages. True by default  
typeYenumthe type of the content type (eg Document, FieldGroup). Valid values: Document, FieldGroup.
  • Document
  • FieldGroup
 
presentationYContentTypePresentation   
fields array[] of ContentTypeFieldlist of fields of this content type  
system System   

ContentTypePresentation

specifies presentation properties of the content type. See official documentation

Properties

propertyrequiredtypedescriptiondetailsexample
displayName stringThe display name of the content type. The default value is the name of the content type. A display name is single-line plain text and may contain spaces and special characters.  
layoutYenumLayout specification for the fields of the document or fieldgroup type. Valid values: one-column, two-column, three-column, horizontal, two-column-mirrored.
  • one-column
  • two-column
  • three-column
  • horizontal
  • two-column-mirrored
 

ContentTypeField

Document and FieldGroup types are comprised of a number of different types of fields. See official documentation

Properties

propertyrequiredtypedescriptiondetailsexample
nameYstringidentifying name of this field within its content type
  • pattern : ^[A-Za-z0-9_]*
 
typeYenumthe type of the field. Valid values: String, Boolean, Integer, Number, Text, Date, Html, RichText, Link, EmbeddedResource, Taxonomy, FieldGroup, SelectableFieldGroup, OpenUiExtension, Id.
  • String
  • Boolean
  • Integer
  • Number
  • Date
  • SelectableString
  • Html
  • RichText
  • Link
  • EmbeddedResource
  • Taxonomy
  • FieldGroup
  • SelectableFieldGroup
  • OpenUiExtension
  • Id
 
required booleanA field can be made required by setting this property to true. Authors can't save documents if they haven't entered a value in a required field. Defaults to false  
multiple booleanA field can be made multi-valued by setting this property to true. This adds plus and minus icons to the field so authors can add or remove values. Defaults to false  
presentationYContentTypeFieldPresentation   
validations ContentTypeFieldValidations   
defaultValue array[] of FieldValuedefault value of this field  

ContentTypeFieldPresentation

specifies presentation properties of the field.
See official documentation

Properties

propertyrequiredtypedescriptiondetailsexample
captionYstringthe caption of a field is the label that is displayed directly above the field in the editing template. Authors will know a field by its caption. A caption is single-line plain text and may contain spaces and special characters.  
hintYstringoptionally a hint to authors can be added to a field. The hint is displayed as a question mark icon with a mouseover popup.  
layoutColumn integerlayoutColumn index used for positioning the field. Starts from 1. Defaults to 1
  • format : int32
 

ContentTypeFieldValidations

validations of the field. Provides configuration for the field

FieldValue

Value of a field

BooleanContentTypeField

This field type is used for boolean values.
See official documentation

Properties

propertyrequiredtypedescriptiondetailsexample
presentation BooleanRadioGroupFieldPresentation   

BooleanRadioGroupFieldPresentation

See Boolean

Properties

propertyrequiredtypedescriptiondetailsexample
captionYstringthe caption of a field is the label that is displayed directly above the field in the editing template. Authors will know a field by its caption. A caption is single-line plain text and may contain spaces and special characters.  
hintYstringoptionally a hint to authors can be added to a field. The hint is displayed as a question mark icon with a mouseover popup.  
layoutColumn integerlayoutColumn index used for positioning the field. Starts from 1. Defaults to 1
  • format : int32
 
displayTypeYenumdisplay type of the field. Valid values: Checkbox, RadioGroup
  • Simple
  • Text
  • Checkbox
  • RadioGroup
  • Dropdown
  • MultiSelect
  • AnyLink
  • ImageLink
 
orientation enumorientation type of the field. Valid values: horizontal, vertical. Defaults to 'horizontal'. Only applicable when displayType is Radiogroup
  • vertical
  • horizontal
 

BooleanRadioGroupFieldValidations

See Boolean

Properties

propertyrequiredtypedescriptiondetailsexample
inResourceBundle stringid of a resource bundle that is used to fetch values from.
In the content type editor, this corresponds to the 'source' property.
From the value list, two keys are read, 'true' and 'false'.
  
inValues array[] of stringslabels of the field. Expects labels of true and false values respectivelyIn the content type editor, this corresponds to the 'trueLabel' and 'falseLabel' properties.  

CheckboxFieldPresentation

See Boolean

Properties

propertyrequiredtypedescriptiondetailsexample
captionYstringthe caption of a field is the label that is displayed directly above the field in the editing template. Authors will know a field by its caption. A caption is single-line plain text and may contain spaces and special characters.  
hintYstringoptionally a hint to authors can be added to a field. The hint is displayed as a question mark icon with a mouseover popup.  
layoutColumn integerlayoutColumn index used for positioning the field. Starts from 1. Defaults to 1
  • format : int32
 
displayTypeYenumdisplay type of the field. Valid values: Checkbox, RadioGroup
  • Simple
  • Text
  • Checkbox
  • RadioGroup
  • Dropdown
  • MultiSelect
  • AnyLink
  • ImageLink
 

CompositeLinkFieldPresentation

specifies presentation properties of the field.
See official documentation

Properties

propertyrequiredtypedescriptiondetailsexample
captionYstringthe caption of a field is the label that is displayed directly above the field in the editing template. Authors will know a field by its caption. A caption is single-line plain text and may contain spaces and special characters.  
hintYstringoptionally a hint to authors can be added to a field. The hint is displayed as a question mark icon with a mouseover popup.  
layoutColumn integerlayoutColumn index used for positioning the field. Starts from 1. Defaults to 1
  • format : int32
 
displayType enum 
  • Simple
  • Text
  • Checkbox
  • RadioGroup
  • Dropdown
  • MultiSelect
  • AnyLink
  • ImageLink
 
lookupFolderTypes array[] of strings   
lastVisitedKey string   
lastVisitedEnabled boolean   
uploadEnabled boolean   
lookupFolderPath string   
lastVisitedNodetypes array[] of strings   
languageContextAware boolean   
pickerType string   

DateContentTypeField

This field type is used for date values.
See official documentation

Properties

propertyrequiredtypedescriptiondetailsexample
presentation DateFieldPresentation   

DateFieldPresentation

See Date

Properties

propertyrequiredtypedescriptiondetailsexample
captionYstringthe caption of a field is the label that is displayed directly above the field in the editing template. Authors will know a field by its caption. A caption is single-line plain text and may contain spaces and special characters.  
hintYstringoptionally a hint to authors can be added to a field. The hint is displayed as a question mark icon with a mouseover popup.  
layoutColumn integerlayoutColumn index used for positioning the field. Starts from 1. Defaults to 1
  • format : int32
 
timeSelectable booleanDefines if the time is also selectable for Date field.  

DropdownFieldPresentation

See SelectableString

Properties

propertyrequiredtypedescriptiondetailsexample
captionYstringthe caption of a field is the label that is displayed directly above the field in the editing template. Authors will know a field by its caption. A caption is single-line plain text and may contain spaces and special characters.  
hintYstringoptionally a hint to authors can be added to a field. The hint is displayed as a question mark icon with a mouseover popup.  
layoutColumn integerlayoutColumn index used for positioning the field. Starts from 1. Defaults to 1
  • format : int32
 
displayTypeYenumdisplay type of the field. Valid values: RadioGroup, Dropdown, MultiSelect
  • Simple
  • Text
  • Checkbox
  • RadioGroup
  • Dropdown
  • MultiSelect
  • AnyLink
  • ImageLink
 
sortOrder enumsortOrder type of the field. Valid values: ascending, descending. Defaults to 'ascending'
  • ascending
  • descending
 
sortBy enumsortBy type of the field. Valid values: key, label. Defaults to 'label'
  • key
  • label
 
showDefault booleanDefines whether the default value 'Choose One' should be shown  

DropdownFieldValidations

See SelectableString

Properties

propertyrequiredtypedescriptiondetailsexample
inResourceBundle stringid of a resource bundle that is used to fetch values from.
In the content type editor, this corresponds to the 'source' property.
  
inValues array[] of KeyLabelExpects an array of key-label values. Not applicable for displayType RadioGroup or MultiSelect
In the content type editor, this corresponds to the 'selectable.options' property.
  

EmbeddedResourceFieldValue

See EmbeddedResource

Properties

propertyrequiredtypedescriptiondetailsexample
filenameYstringthe name of the file that is used as default value  
binarydataYstringthe binary data of the file that is used as default value. This data has to be encoded using base64  
mimeTypeYstringthe mimeType of the file to be uploaded  

FieldGroupContentTypeField

The FieldGroup field type provides content authors with the ability to add one pre-configured fieldgroup type to a document. All the fields that the fieldgroup type specifies become fields of the enclosing document, visually grouped together.
See FieldGroup

Properties

propertyrequiredtypedescriptiondetailsexample
fieldGroupType stringthe name of the fieldgroup type that this field will use. Unless the field group type belongs to the default group ('brxsaas'), the name must be prefixed with the group name and the colon character, e.g. 'mygroup:myfieldgrouptype'  

FieldGroupFieldValue

See FieldGroup

Properties

propertyrequiredtypedescriptiondetailsexample
fieldsYobjectfields from FieldGroup or SelectableFieldGroup  

HtmlFieldPresentation

See HTML fields

Properties

propertyrequiredtypedescriptiondetailsexample
captionYstringthe caption of a field is the label that is displayed directly above the field in the editing template. Authors will know a field by its caption. A caption is single-line plain text and may contain spaces and special characters.  
hintYstringoptionally a hint to authors can be added to a field. The hint is displayed as a question mark icon with a mouseover popup.  
layoutColumn integerlayoutColumn index used for positioning the field. Starts from 1. Defaults to 1
  • format : int32
 
ckEditorAppendedJson stringJSON configuration object for CKEditor.
In the content type editor, this corresponds to the 'ckeditor.config.appended.json' property
  
ckEditorOverlayedJson stringJSON configuration object for CKEditor.
In the content type editor, this corresponds to the 'ckeditor.config.overlayed.json' property
  

ImageLinkFieldPresentation

See Link

Properties

propertyrequiredtypedescriptiondetailsexample
captionYstringthe caption of a field is the label that is displayed directly above the field in the editing template. Authors will know a field by its caption. A caption is single-line plain text and may contain spaces and special characters.  
hintYstringoptionally a hint to authors can be added to a field. The hint is displayed as a question mark icon with a mouseover popup.  
layoutColumn integerlayoutColumn index used for positioning the field. Starts from 1. Defaults to 1
  • format : int32
 
uploadEnabled booleanwhether the user is allowed to upload new files from within the picker dialog, defaults to true  
displayTypeYenumdisplay type of the field. Valid values: AnyLink, ImageLink
  • Simple
  • Text
  • Checkbox
  • RadioGroup
  • Dropdown
  • MultiSelect
  • AnyLink
  • ImageLink
 
lookupFolderTypes array[] of stringsImageset types allowed for selection.
In the content type editor, this corresponds to the 'nodetypes' property.
Any types that do not belong to the default group ('brxsaas'), must be prefixed with the group name and the colon character, e.g. 'mygroup:mytype'.
  
lastVisitedKey stringIf specified, the last visited folder is stored separately for this key. This allows managing multiple 'last visited folders', for example, one for each content type.If not specified, the last visited folder is 'shared' with all other link fields that have not specified a lastVisitedKey. Defaults to 'gallerypicker-imagelink'.
In the content type editor, this corresponds to the 'last.visited.key' property
  
lastVisitedEnabled booleanEnables to remember and open the last opened folder for the session in the picker dialog. True by default.
In the content type editor, this corresponds to the 'last.visited.enabled' property
  

KeyLabel

Expects an array of key-label values. Not applicable for displayType RadioGroup or MultiSelect
In the content type editor, this corresponds to the 'selectable.options' property.

Properties

propertyrequiredtypedescriptiondetailsexample
keyYstringkey validation of the field. Expects a string value  
labelYstringlabel validation of the field. Expects a string value  

LinkAndImageLinkContentTypeField

This field type is used for all but FieldGroup and SelectableFieldGroup fields.
See official documentation

Properties

propertyrequiredtypedescriptiondetailsexample
presentation CompositeLinkFieldPresentation   

LinkFieldPresentation

See Link

Properties

propertyrequiredtypedescriptiondetailsexample
captionYstringthe caption of a field is the label that is displayed directly above the field in the editing template. Authors will know a field by its caption. A caption is single-line plain text and may contain spaces and special characters.  
hintYstringoptionally a hint to authors can be added to a field. The hint is displayed as a question mark icon with a mouseover popup.  
layoutColumn integerlayoutColumn index used for positioning the field. Starts from 1. Defaults to 1
  • format : int32
 
lookupFolderPath stringThe path of the default folder to show when the Link Picker dialog opens.
In the content type editor, this corresponds to the 'base.path' property
  
lastVisitedNodetypes array[] of stringsBy default, only hippostd:folder type nodes are regarded as 'last visited folders' mentioned above. If you have any custom node types representing folder other than hippostd:folder, then you can specify other node types.
In the content type editor, this corresponds to the 'last.visited.nodetypes' property.
Any types that do not belong to the default group ('brxsaas'), must be prefixed with the group name and the colon character, e.g. 'mygroup:mytype'.
  
languageContextAware booleanIf true the Link Picker dialog by default opens the root content folder for the current document's language. True by default, however if lastVisitedEnabled is set, it takes precedence so has to be set to false.
In the content type editor, this corresponds to the 'language.context.aware' property
  
pickerType stringthe type of the picker to use. Valid values: documents, images, assets, folders, documents-only, documents-folders-only. Defaults to 'documents'.
In the content type editor, this corresponds to the 'cluster.name' property. The API takes care of managing the 'cms-pickers' prefix.
  
displayTypeYenumdisplay type of the field. Valid values: AnyLink, ImageLink
  • Simple
  • Text
  • Checkbox
  • RadioGroup
  • Dropdown
  • MultiSelect
  • AnyLink
  • ImageLink
 
lookupFolderTypes array[] of stringsContent types allowed for selection.
In the content type editor, this corresponds to the 'nodetypes' property.
Any types that do not belong to the default group ('brxsaas'), must be prefixed with the group name and the colon character, e.g. 'mygroup:mytype'.
  
lastVisitedKey stringIf specified, the last visited folder is stored separately for this key. This allows managing multiple 'last visited folders', for example, one for each content type.If not specified, the last visited folder is 'shared' with all other link fields that have not specified a lastVisitedKey.
In the content type editor, this corresponds to the 'last.visited.key' property
  
lastVisitedEnabled booleanEnables to remember and open the last opened folder for the session in the picker dialog. True by default.
In the content type editor, this corresponds to the 'last.visited.enabled' property
  

MultiSelectAndRadioGroupFieldsValidations

See SelectableString

Properties

propertyrequiredtypedescriptiondetailsexample
inResourceBundle stringid of a resource bundle that is used to fetch values from.
In the content type editor, this corresponds to the 'source' property.
  

MultiSelectFieldPresentation

The Multi Select field lets authors select multiple elements from a list of possible options. Before setting up this field, the authors have to create a document of the type resource bundle, which will provide the options to be selected.
See SelectableString

Properties

propertyrequiredtypedescriptiondetailsexample
captionYstringthe caption of a field is the label that is displayed directly above the field in the editing template. Authors will know a field by its caption. A caption is single-line plain text and may contain spaces and special characters.  
hintYstringoptionally a hint to authors can be added to a field. The hint is displayed as a question mark icon with a mouseover popup.  
layoutColumn integerlayoutColumn index used for positioning the field. Starts from 1. Defaults to 1
  • format : int32
 
displayTypeYenumdisplay type of the field. Valid values: RadioGroup, Dropdown, MultiSelect
  • Simple
  • Text
  • Checkbox
  • RadioGroup
  • Dropdown
  • MultiSelect
  • AnyLink
  • ImageLink
 
multiSelectType enumThis property determines the user interface of the field. Valid values are: selectlist, checkboxes, palette.
  • selectlist
  • checkboxes
  • palette
 
maxRowWithoutScrollbar integerin case of using the selectlist or palette representations, this property allows to set the maximum number of elements shown (if there are more elements, a scrollbar will appear.
In the content type editor, this corresponds to the 'selectlist.maxrows' and 'palette.maxrows' properties.
  • format : int32
 
multiSelectAllowOrder booleanin case of using the palette representation, if set to 'true', it will be possible to manually order the elements on the 'selected' list.
In the content type editor, this corresponds to the 'palette.alloworder' property
  

OpenUiExtensionFieldPresentation

See Open UI String

Properties

propertyrequiredtypedescriptiondetailsexample
captionYstringthe caption of a field is the label that is displayed directly above the field in the editing template. Authors will know a field by its caption. A caption is single-line plain text and may contain spaces and special characters.  
hintYstringoptionally a hint to authors can be added to a field. The hint is displayed as a question mark icon with a mouseover popup.  
layoutColumn integerlayoutColumn index used for positioning the field. Starts from 1. Defaults to 1
  • format : int32
 
extensionType stringthe name of the extension that will be used.
In the content type editor, this corresponds to the 'ui.extension' property
  

RadioGroupFieldPresentation

See SelectableString

Properties

propertyrequiredtypedescriptiondetailsexample
captionYstringthe caption of a field is the label that is displayed directly above the field in the editing template. Authors will know a field by its caption. A caption is single-line plain text and may contain spaces and special characters.  
hintYstringoptionally a hint to authors can be added to a field. The hint is displayed as a question mark icon with a mouseover popup.  
layoutColumn integerlayoutColumn index used for positioning the field. Starts from 1. Defaults to 1
  • format : int32
 
displayTypeYenumdisplay type of the field. Valid values: RadioGroup, Dropdown, MultiSelect
  • Simple
  • Text
  • Checkbox
  • RadioGroup
  • Dropdown
  • MultiSelect
  • AnyLink
  • ImageLink
 
orientation enumorientation type of the field. Valid values: horizontal, vertical. Defaults to 'horizontal'
  • vertical
  • horizontal
 
sortOrder enumsortOrder type of the field. Valid values: ascending, descending. Defaults to 'ascending'
  • ascending
  • descending
 
sortBy enumsortBy type of the field. Valid values: key, label. Defaults to 'label'
  • key
  • label
 

RichTextFieldPresentation

See Rich Text

Properties

propertyrequiredtypedescriptiondetailsexample
captionYstringthe caption of a field is the label that is displayed directly above the field in the editing template. Authors will know a field by its caption. A caption is single-line plain text and may contain spaces and special characters.  
hintYstringoptionally a hint to authors can be added to a field. The hint is displayed as a question mark icon with a mouseover popup.  
layoutColumn integerlayoutColumn index used for positioning the field. Starts from 1. Defaults to 1
  • format : int32
 
ckEditorAppendedJson stringJSON configuration object for CKEditor.
In the content type editor, this corresponds to the 'ckeditor.config.appended.json' property
  
ckEditorOverlayedJson stringJSON configuration object for CKEditor.
In the content type editor, this corresponds to the 'ckeditor.config.overlayed.json' property
  
imagepickerBasePath stringpath of the node to open in the picker by default if no 'last visited' node is available. Use an empty string to disable this feature.
In the content type editor, this corresponds to the 'imagepicker.base.uuid' property. The API takes care of converting from path to uuid and vice versa.
  
imagepickerType stringthe type of the picker to use. Valid values: documents, images, assets, folders, documents-only, documents-folders-only. Defaults to 'images'.
In the content type editor, this corresponds to the 'imagepicker.cluster.name' property. The API takes care of managing the 'cms-pickers' prefix.
  
imagepickerNodetypes array[] of stringsone or more JCR node types (comma separated) specifying the content types that can be selected. By default, all types are selectable.
In the content type editor, this corresponds to the 'imagepicker.nodetypes' property.
Any types that do not belong to the default group ('brxsaas'), must be prefixed with the group name and the colon character, e.g. 'mygroup:mytype'.
  
imagepickerLastVisitedEnabled booleanWhether to store the last visited node. Defaults to true.
In the content type editor, this corresponds to the 'imagepicker.last.visited.enabled' property.
  
imagepickerLastVisitedGroupKey stringKey to store the last visited node in the link picker dialog under. Use a unique value to remember the last visited node separately from other CKEditor link picker dialogs. Default: ckeditor-imagepicker.
In the content type editor, this corresponds to the 'imagepicker.last.visited.key' property.
  
imagepickerLastVisitedNodetypes array[] of stringsThe JCR node type(s) allowed to be stored as last visited node. Default: hippostd:gallery.
In the content type editor, this corresponds to the 'imagepicker.last.visited.nodetypes' property.
Any types that do not belong to the default group ('brxsaas'), must be prefixed with the group name and the colon character, e.g. 'mygroup:mytype'.
  
imagepickerPreferredImageVariant stringThe image variant to select by default in the variant combo box of the image picker.Default: hippogallery:original.
In the content type editor, this corresponds to the 'imagepicker.preferred.image.variant' property.
  
linkpickerBasePath stringpath of the node to open in the picker by default if no 'last visited' node is available. Use an empty string to disable this feature.
In the content type editor, this corresponds to the 'linkpicker.base.uuid' property. The API takes care of converting from path to uuid and vice versa.
  
linkpickerType stringthe type of the picker to use. Valid values: documents, images, assets, folders, documents-only, documents-folders-only. Defaults to 'documents'.
In the content type editor, this corresponds to the 'linkpicker.cluster.name' property. The API takes care of managing the 'cms-pickers' prefix.
  
linkpickerNodetypes array[] of stringsone or more JCR node types specifying the content types that can be selected. By default, all types are selectable.
In the content type editor, this corresponds to the 'linkpicker.nodetypes' property.
Any types that do not belong to the default group ('brxsaas'), must be prefixed with the group name and the colon character, e.g. 'mygroup:mytype'.
  
linkpickerLastVisitedEnabled booleanWhether to store the last visited node. Defaults to true.
In the content type editor, this corresponds to the 'linkpicker.last.visited.enabled' property.
  
linkpickerLastVisitedGroupKey stringKey to store the last visited node in the link picker dialog under. Use a unique value to remember the last visited node separately from other CKEditor link picker dialogs. Default: ckeditor-documentpicker.
In the content type editor, this corresponds to the 'linkpicker.last.visited.key' property.
  
linkpickerLastVisitedNodetypes array[] of stringsThe JCR node type(s) allowed to be stored as last visited node. Default: hippostd:folder.
In the content type editor, this corresponds to the 'linkpicker.last.visited.nodetypes' property.
Any types that do not belong to the default group ('brxsaas'), must be prefixed with the group name and the colon character, e.g. 'mygroup:mytype'.
  
linkPickerLanguageContextAware booleanWhether the starting folder of the documentpicker is the folder of the language of the document. Defaults to true.
In the content type editor, this corresponds to the 'linkpicker.language.context.aware' property.
  
linkPickerOpenInNewWindowEnabled booleanWhether to show to 'open in new window' checkbox in the link picker dialog. Defaults to true.
In the content type editor, this corresponds to the 'linkpicker.open.in.new.window.enabled' property.
  
includeImageVariants array[] of stringsThe (comma separated) JCR node type(s) of image variants to be included in the 'Size' dropdown of the image picker dialog. If empty all image variants will be included.
In the content type editor, this corresponds to the 'included.image.variants' property.
  
excludeImageVariants array[] of stringsThe (comma separated) JCR node type(s) to be excluded from the 'Size' dropdown of the image picker dialog.
In the content type editor, this corresponds to the 'excluded.image.variants' property.
  

SelectableFieldGroupContentTypeField

The SelectableFieldGroup field type provides content authors with the ability to add pre-configured fieldgroup types to a document, which allows for more flexible content types in which authors have the freedom to choose which compound(s) to use.
See Selectable FieldGroup

Properties

propertyrequiredtypedescriptiondetailsexample
fieldGroupTypes array[] of stringsan array of fieldgroup types that will be enabed in this group of fieldgroups.
In the content type editor, this corresponds to the 'compoundList' property.
Any field groups that do not belong to the default group ('brxsaas'), must be prefixed with the group name and the colon character, e.g. 'mygroup:myfieldgrouptype'.
  

SelectableFieldGroupFieldValidations

See Selectable FieldGroup

Properties

propertyrequiredtypedescriptiondetailsexample
maxItem integerwhen the multiple option is selected, the maximum number of items that can be added. If multiple is not selected, the maximum number will be 1, regardless the value of this field.
In the content type editor, this corresponds to the 'maxitems' property
  • format : int32
 

SelectableFieldGroupFieldValue

See Selectable FieldGroup

Properties

propertyrequiredtypedescriptiondetailsexample
fieldsYobjectfields from FieldGroup or SelectableFieldGroup  
fieldGroupTypeYstringthe name of the fieldgroup type this default value is provided for. Unless the field group type belongs to the default group ('brxsaas'), the name must be prefixed with the group name and the colon character, e.g. 'mygroup:myfieldgrouptype'  

SelectableFieldGroupPresentation

See Selectable FieldGroup

Properties

propertyrequiredtypedescriptiondetailsexample
captionYstringthe caption of a field is the label that is displayed directly above the field in the editing template. Authors will know a field by its caption. A caption is single-line plain text and may contain spaces and special characters.  
hintYstringoptionally a hint to authors can be added to a field. The hint is displayed as a question mark icon with a mouseover popup.  
layoutColumn integerlayoutColumn index used for positioning the field. Starts from 1. Defaults to 1
  • format : int32
 
contentPickerType enumthe way the picker buttons will be rendered. The valid values are 'links' (default) and 'dropdown': links: shows as many buttons as available compounds. When hitting a button, adds a new block of that compound type dropdown: presents a dropdown containing all the available compounds and an additional button to add an item of the selected compound of the dropdown
  • links
  • dropdown
 
showFieldGroupNames booleanthe valid values are 'false' (default) and 'true', it determines whether each item should add the field group name on top of it. When it's active, clicking on the name will collapse or expand the item.
In the content type editor, this corresponds to the 'showCompoundNames' property
  

SimpleContentTypeField

This field type is used for all but FieldGroup and SelectableFieldGroup fields.
See official documentation

StringFieldPresentation

See String

Properties

propertyrequiredtypedescriptiondetailsexample
captionYstringthe caption of a field is the label that is displayed directly above the field in the editing template. Authors will know a field by its caption. A caption is single-line plain text and may contain spaces and special characters.  
hintYstringoptionally a hint to authors can be added to a field. The hint is displayed as a question mark icon with a mouseover popup.  
layoutColumn integerlayoutColumn index used for positioning the field. Starts from 1. Defaults to 1
  • format : int32
 
displayTypeYenumdisplay type of the field. Valid values: Simple, Text.
  • Simple
  • Text
  • Checkbox
  • RadioGroup
  • Dropdown
  • MultiSelect
  • AnyLink
  • ImageLink
 

StringSimpleFieldValidations

 

Properties

propertyrequiredtypedescriptiondetailsexample
maxLength integermaxLength determines the maximum number of characters allowed in this string field. Expects an integer value
  • format : int32
 

System

system properties

Properties

propertyrequiredtypedescriptiondetailsexample
createdBy string   
createdAt date-time   
updatedBy string   
updatedAt date-time   

TaxonomyFieldValidations

See Taxonomy

Properties

propertyrequiredtypedescriptiondetailsexample
inTaxonomy stringthe name of the taxonomy document that will be used. Expects a string value.
In the content type editor, this corresponds to the 'taxonomy.name' property
  

TextFieldValidations

 

Properties

propertyrequiredtypedescriptiondetailsexample
maxRow integermaxRow determines the number of rows shown for the textarea this field renders. Expects an integer value
  • format : int32
 

ContentTypeRename

Content type rename properties

Properties

propertyrequiredtypedescriptiondetailsexample
newNameYstringnew name of the content type  
displayNameYstringnew display name of the content type Â