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

property	required	type	description	details
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.	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.	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
name	Y	string	identifying name of this field within its content type	pattern : ^[A-Za-z0-9_]*
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.	String Boolean Integer Number Date SelectableString 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
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	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

property	required	type	description	details	example
presentation		BooleanRadioGroupFieldPresentation

BooleanRadioGroupFieldPresentation

See Boolean

Properties

property	required	type	description	details
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	format : int32
displayType	Y	enum	display type of the field. Valid values: Checkbox, RadioGroup	Simple Text Checkbox RadioGroup Dropdown MultiSelect AnyLink ImageLink
orientation		enum	orientation type of the field. Valid values: horizontal, vertical. Defaults to 'horizontal'. Only applicable when displayType is Radiogroup	vertical horizontal

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
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	format : int32
displayType	Y	enum	display 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

property	required	type	description	details
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	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

property	required	type	description	details	example
presentation		DateFieldPresentation

DateFieldPresentation

See Date

Properties

property	required	type	description	details
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	format : int32
timeSelectable		boolean	Defines if the time is also selectable for Date field.

DropdownFieldPresentation

See SelectableString

Properties

property	required	type	description	details
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	format : int32
displayType	Y	enum	display type of the field. Valid values: RadioGroup, Dropdown, MultiSelect	Simple Text Checkbox RadioGroup Dropdown MultiSelect AnyLink ImageLink
sortOrder		enum	sortOrder type of the field. Valid values: ascending, descending. Defaults to 'ascending'	ascending descending
sortBy		enum	sortBy type of the field. Valid values: key, label. Defaults to 'label'	key 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
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
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	format : int32
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
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	format : int32
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	Simple Text Checkbox RadioGroup Dropdown MultiSelect 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
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	format : int32
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	Simple Text Checkbox RadioGroup Dropdown MultiSelect 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
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	format : int32
displayType	Y	enum	display type of the field. Valid values: RadioGroup, Dropdown, MultiSelect	Simple Text Checkbox RadioGroup Dropdown MultiSelect AnyLink ImageLink
multiSelectType		enum	This property determines the user interface of the field. Valid values are: selectlist, checkboxes, palette.	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.	format : int32
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
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	format : int32
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
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	format : int32
displayType	Y	enum	display type of the field. Valid values: RadioGroup, Dropdown, MultiSelect	Simple Text Checkbox RadioGroup Dropdown MultiSelect AnyLink ImageLink
orientation		enum	orientation type of the field. Valid values: horizontal, vertical. Defaults to 'horizontal'	vertical horizontal
sortOrder		enum	sortOrder type of the field. Valid values: ascending, descending. Defaults to 'ascending'	ascending descending
sortBy		enum	sortBy type of the field. Valid values: key, label. Defaults to 'label'	key label

RichTextFieldPresentation

See Rich Text

Properties

property	required	type	description	details
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	format : int32
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

See Selectable FieldGroup

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	format : int32

SelectableFieldGroupFieldValue

See Selectable FieldGroup

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

See Selectable FieldGroup

Properties

property	required	type	description	details
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	format : int32
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	links 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
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	format : int32
displayType	Y	enum	display type of the field. Valid values: Simple, Text.	Simple Text Checkbox RadioGroup Dropdown MultiSelect AnyLink ImageLink

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	format : int32

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	format : int32

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