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
property | required | type | description | details | example |
---|---|---|---|---|---|
name | Y | string | identifying 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 | Â | boolean | whether the content type is available for authors and editors to create new documents and pages. True by default | Â | Â |
type | Y | enum | the type of the content type (eg Document, FieldGroup). Valid values: Document, FieldGroup. |
| Â |
presentation | Y | ContentTypePresentation | Â | Â | Â |
fields | Â | array[] of ContentTypeField | list of fields of this content type | Â | Â |
system | Â | System | Â | Â | Â |
ContentTypePresentation
specifies presentation properties of the content type. See official documentation
Properties
property | required | type | description | details | example |
---|---|---|---|---|---|
displayName | Â | string | The 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. | Â | Â |
layout | Y | enum | Layout specification for the fields of the document or fieldgroup type. Valid values: 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
property | required | type | description | details | example |
---|---|---|---|---|---|
name | Y | string | identifying name of this field within its content type |
| Â |
type | Y | enum | the type of the field. Valid values: String, Boolean, Integer, Number, Text, Date, Html, RichText, Link, EmbeddedResource, Taxonomy, FieldGroup, SelectableFieldGroup, OpenUiExtension, Id. |
| Â |
required | Â | boolean | A 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 | Â | boolean | A 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 | Â | Â |
presentation | Y | ContentTypeFieldPresentation | Â | Â | Â |
validations | Â | ContentTypeFieldValidations | Â | Â | Â |
defaultValue | Â | array[] of FieldValue | default value of this field | Â | Â |
ContentTypeFieldPresentation
specifies presentation properties of the field.
See official documentation
Properties
property | required | type | description | details | example |
---|---|---|---|---|---|
caption | Y | string | the 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. | Â | Â |
hint | Y | string | optionally a hint to authors can be added to a field. The hint is displayed as a question mark icon with a mouseover popup. | Â | Â |
layoutColumn | Â | integer | layoutColumn index used for positioning the field. Starts from 1. Defaults to 1 |
| Â |
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
property | required | type | description | details | example |
---|---|---|---|---|---|
presentation | Â | BooleanRadioGroupFieldPresentation | Â | Â | Â |
BooleanRadioGroupFieldPresentation
See Boolean
Properties
property | required | type | description | details | example |
---|---|---|---|---|---|
caption | Y | string | the 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. | Â | Â |
hint | Y | string | optionally a hint to authors can be added to a field. The hint is displayed as a question mark icon with a mouseover popup. | Â | Â |
layoutColumn | Â | integer | layoutColumn index used for positioning the field. Starts from 1. Defaults to 1 |
| Â |
displayType | Y | enum | display type of the field. Valid values: Checkbox, RadioGroup |
| Â |
orientation | Â | enum | orientation type of the field. Valid values: horizontal, vertical. Defaults to 'horizontal'. Only applicable when displayType is Radiogroup |
| Â |
BooleanRadioGroupFieldValidations
See Boolean
Properties
property | required | type | description | details | example |
---|---|---|---|---|---|
inResourceBundle | Â | string | id 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 strings | labels 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
property | required | type | description | details | example |
---|---|---|---|---|---|
caption | Y | string | the 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. | Â | Â |
hint | Y | string | optionally a hint to authors can be added to a field. The hint is displayed as a question mark icon with a mouseover popup. | Â | Â |
layoutColumn | Â | integer | layoutColumn index used for positioning the field. Starts from 1. Defaults to 1 |
| Â |
displayType | Y | enum | display type of the field. Valid values: Checkbox, RadioGroup |
| Â |
CompositeLinkFieldPresentation
specifies presentation properties of the field.
See official documentation
Properties
property | required | type | description | details | example |
---|---|---|---|---|---|
caption | Y | string | the 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. | Â | Â |
hint | Y | string | optionally a hint to authors can be added to a field. The hint is displayed as a question mark icon with a mouseover popup. | Â | Â |
layoutColumn | Â | integer | layoutColumn index used for positioning the field. Starts from 1. Defaults to 1 |
| Â |
displayType | Â | enum | Â |
| Â |
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
property | required | type | description | details | example |
---|---|---|---|---|---|
presentation | Â | DateFieldPresentation | Â | Â | Â |
DateFieldPresentation
See Date
Properties
property | required | type | description | details | example |
---|---|---|---|---|---|
caption | Y | string | the 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. | Â | Â |
hint | Y | string | optionally a hint to authors can be added to a field. The hint is displayed as a question mark icon with a mouseover popup. | Â | Â |
layoutColumn | Â | integer | layoutColumn index used for positioning the field. Starts from 1. Defaults to 1 |
| Â |
timeSelectable | Â | boolean | Defines if the time is also selectable for Date field. | Â | Â |
DropdownFieldPresentation
See SelectableString
Properties
property | required | type | description | details | example |
---|---|---|---|---|---|
caption | Y | string | the 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. | Â | Â |
hint | Y | string | optionally a hint to authors can be added to a field. The hint is displayed as a question mark icon with a mouseover popup. | Â | Â |
layoutColumn | Â | integer | layoutColumn index used for positioning the field. Starts from 1. Defaults to 1 |
| Â |
displayType | Y | enum | display type of the field. Valid values: RadioGroup, Dropdown, MultiSelect |
| Â |
sortOrder | Â | enum | sortOrder type of the field. Valid values: ascending, descending. Defaults to 'ascending' |
| Â |
sortBy | Â | enum | sortBy type of the field. Valid values: key, label. Defaults to 'label' |
| Â |
showDefault | Â | boolean | Defines whether the default value 'Choose One' should be shown | Â | Â |
DropdownFieldValidations
See SelectableString
Properties
property | required | type | description | details | example |
---|---|---|---|---|---|
inResourceBundle | Â | string | id 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 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. | Â | Â |
EmbeddedResourceFieldValue
See EmbeddedResource
Properties
property | required | type | description | details | example |
---|---|---|---|---|---|
filename | Y | string | the name of the file that is used as default value | Â | Â |
binarydata | Y | string | the binary data of the file that is used as default value. This data has to be encoded using base64 | Â | Â |
mimeType | Y | string | the 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
property | required | type | description | details | example |
---|---|---|---|---|---|
fieldGroupType | Â | string | the 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
property | required | type | description | details | example |
---|---|---|---|---|---|
fields | Y | object | fields from FieldGroup or SelectableFieldGroup | Â | Â |
HtmlFieldPresentation
See HTML fields
Properties
property | required | type | description | details | example |
---|---|---|---|---|---|
caption | Y | string | the 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. | Â | Â |
hint | Y | string | optionally a hint to authors can be added to a field. The hint is displayed as a question mark icon with a mouseover popup. | Â | Â |
layoutColumn | Â | integer | layoutColumn index used for positioning the field. Starts from 1. Defaults to 1 |
| Â |
ckEditorAppendedJson | Â | string | JSON configuration object for CKEditor. In the content type editor, this corresponds to the 'ckeditor.config.appended.json' property | Â | Â |
ckEditorOverlayedJson | Â | string | JSON configuration object for CKEditor. In the content type editor, this corresponds to the 'ckeditor.config.overlayed.json' property | Â | Â |
ImageLinkFieldPresentation
See Link
Properties
property | required | type | description | details | example |
---|---|---|---|---|---|
caption | Y | string | the 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. | Â | Â |
hint | Y | string | optionally a hint to authors can be added to a field. The hint is displayed as a question mark icon with a mouseover popup. | Â | Â |
layoutColumn | Â | integer | layoutColumn index used for positioning the field. Starts from 1. Defaults to 1 |
| Â |
uploadEnabled | Â | boolean | whether the user is allowed to upload new files from within the picker dialog, defaults to true | Â | Â |
displayType | Y | enum | display type of the field. Valid values: AnyLink, ImageLink |
| Â |
lookupFolderTypes | Â | array[] of strings | Imageset 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 | Â | string | If 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 | Â | boolean | Enables 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
property | required | type | description | details | example |
---|---|---|---|---|---|
key | Y | string | key validation of the field. Expects a string value | Â | Â |
label | Y | string | label 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
property | required | type | description | details | example |
---|---|---|---|---|---|
presentation | Â | CompositeLinkFieldPresentation | Â | Â | Â |
LinkFieldPresentation
See Link
Properties
property | required | type | description | details | example |
---|---|---|---|---|---|
caption | Y | string | the 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. | Â | Â |
hint | Y | string | optionally a hint to authors can be added to a field. The hint is displayed as a question mark icon with a mouseover popup. | Â | Â |
layoutColumn | Â | integer | layoutColumn index used for positioning the field. Starts from 1. Defaults to 1 |
| Â |
lookupFolderPath | Â | string | The 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 strings | By 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 | Â | boolean | If 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 | Â | string | the 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. | Â | Â |
displayType | Y | enum | display type of the field. Valid values: AnyLink, ImageLink |
| Â |
lookupFolderTypes | Â | array[] of strings | Content 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 | Â | string | If 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 | Â | boolean | Enables 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
property | required | type | description | details | example |
---|---|---|---|---|---|
inResourceBundle | Â | string | id 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
property | required | type | description | details | example |
---|---|---|---|---|---|
caption | Y | string | the 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. | Â | Â |
hint | Y | string | optionally a hint to authors can be added to a field. The hint is displayed as a question mark icon with a mouseover popup. | Â | Â |
layoutColumn | Â | integer | layoutColumn index used for positioning the field. Starts from 1. Defaults to 1 |
| Â |
displayType | Y | enum | display type of the field. Valid values: RadioGroup, Dropdown, MultiSelect |
| Â |
multiSelectType | Â | enum | This property determines the user interface of the field. Valid values are: selectlist, checkboxes, palette. |
| Â |
maxRowWithoutScrollbar | Â | integer | in 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. |
| Â |
multiSelectAllowOrder | Â | boolean | in 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
property | required | type | description | details | example |
---|---|---|---|---|---|
caption | Y | string | the 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. | Â | Â |
hint | Y | string | optionally a hint to authors can be added to a field. The hint is displayed as a question mark icon with a mouseover popup. | Â | Â |
layoutColumn | Â | integer | layoutColumn index used for positioning the field. Starts from 1. Defaults to 1 |
| Â |
extensionType | Â | string | the name of the extension that will be used. In the content type editor, this corresponds to the 'ui.extension' property | Â | Â |
RadioGroupFieldPresentation
See SelectableString
Properties
property | required | type | description | details | example |
---|---|---|---|---|---|
caption | Y | string | the 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. | Â | Â |
hint | Y | string | optionally a hint to authors can be added to a field. The hint is displayed as a question mark icon with a mouseover popup. | Â | Â |
layoutColumn | Â | integer | layoutColumn index used for positioning the field. Starts from 1. Defaults to 1 |
| Â |
displayType | Y | enum | display type of the field. Valid values: RadioGroup, Dropdown, MultiSelect |
| Â |
orientation | Â | enum | orientation type of the field. Valid values: horizontal, vertical. Defaults to 'horizontal' |
| Â |
sortOrder | Â | enum | sortOrder type of the field. Valid values: ascending, descending. Defaults to 'ascending' |
| Â |
sortBy | Â | enum | sortBy type of the field. Valid values: key, label. Defaults to 'label' |
| Â |
RichTextFieldPresentation
See Rich Text
Properties
property | required | type | description | details | example |
---|---|---|---|---|---|
caption | Y | string | the 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. | Â | Â |
hint | Y | string | optionally a hint to authors can be added to a field. The hint is displayed as a question mark icon with a mouseover popup. | Â | Â |
layoutColumn | Â | integer | layoutColumn index used for positioning the field. Starts from 1. Defaults to 1 |
| Â |
ckEditorAppendedJson | Â | string | JSON configuration object for CKEditor. In the content type editor, this corresponds to the 'ckeditor.config.appended.json' property | Â | Â |
ckEditorOverlayedJson | Â | string | JSON configuration object for CKEditor. In the content type editor, this corresponds to the 'ckeditor.config.overlayed.json' property | Â | Â |
imagepickerBasePath | Â | string | path 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 | Â | string | the 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 strings | one 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 | Â | boolean | Whether to store the last visited node. Defaults to true. In the content type editor, this corresponds to the 'imagepicker.last.visited.enabled' property. | Â | Â |
imagepickerLastVisitedGroupKey | Â | string | Key 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 strings | The 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 | Â | string | The 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 | Â | string | path 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 | Â | string | the 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 strings | one 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 | Â | boolean | Whether to store the last visited node. Defaults to true. In the content type editor, this corresponds to the 'linkpicker.last.visited.enabled' property. | Â | Â |
linkpickerLastVisitedGroupKey | Â | string | Key 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 strings | The 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 | Â | boolean | Whether 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 | Â | boolean | Whether 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 strings | The (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 strings | The (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
property | required | type | description | details | example |
---|---|---|---|---|---|
fieldGroupTypes | Â | array[] of strings | an 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
Properties
property | required | type | description | details | example |
---|---|---|---|---|---|
maxItem | Â | integer | when 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 |
| Â |
SelectableFieldGroupFieldValue
Properties
property | required | type | description | details | example |
---|---|---|---|---|---|
fields | Y | object | fields from FieldGroup or SelectableFieldGroup | Â | Â |
fieldGroupType | Y | string | the 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
Properties
property | required | type | description | details | example |
---|---|---|---|---|---|
caption | Y | string | the 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. | Â | Â |
hint | Y | string | optionally a hint to authors can be added to a field. The hint is displayed as a question mark icon with a mouseover popup. | Â | Â |
layoutColumn | Â | integer | layoutColumn index used for positioning the field. Starts from 1. Defaults to 1 |
| Â |
contentPickerType | Â | enum | the 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 |
| Â |
showFieldGroupNames | Â | boolean | the 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
property | required | type | description | details | example |
---|---|---|---|---|---|
caption | Y | string | the 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. | Â | Â |
hint | Y | string | optionally a hint to authors can be added to a field. The hint is displayed as a question mark icon with a mouseover popup. | Â | Â |
layoutColumn | Â | integer | layoutColumn index used for positioning the field. Starts from 1. Defaults to 1 |
| Â |
displayType | Y | enum | display type of the field. Valid values: Simple, Text. |
| Â |
StringSimpleFieldValidations
Â
Properties
property | required | type | description | details | example |
---|---|---|---|---|---|
maxLength | Â | integer | maxLength determines the maximum number of characters allowed in this string field. Expects an integer value |
| Â |
System
system properties
Properties
property | required | type | description | details | example |
---|---|---|---|---|---|
createdBy | Â | string | Â | Â | Â |
createdAt | Â | date-time | Â | Â | Â |
updatedBy | Â | string | Â | Â | Â |
updatedAt | Â | date-time | Â | Â | Â |
TaxonomyFieldValidations
See Taxonomy
Properties
property | required | type | description | details | example |
---|---|---|---|---|---|
inTaxonomy | Â | string | the 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
property | required | type | description | details | example |
---|---|---|---|---|---|
maxRow | Â | integer | maxRow determines the number of rows shown for the textarea this field renders. Expects an integer value |
| Â |
ContentTypeRename
Content type rename properties
Properties
property | required | type | description | details | example |
---|---|---|---|---|---|
newName | Y | string | new name of the content type | Â | Â |
displayName | Y | string | new display name of the content type | Â | Â |