BooleanRadioGroupFieldPresentation
caption* | string the caption used for this field in UIs |
hint* | string the hint used for this field in UIs |
layoutColumn | integer($int32) layoutColumn index used for positioning the field |
displayType* | string readOnly: true display type of the field. Valid values: Checkbox, RadioGroup Enum: [ Simple, Text, Checkbox, RadioGroup, Dropdown, MultiSelect, AnyLink, ImageLink ] |
orientation | string readOnly: true orientation type of the field. Enum: [ vertical, horizontal ] |
ContentType
name* | string | |
---|---|---|
type* | string Enum: | |
enabled | boolean whether the content type is enabled, true by default | |
presentation* | ContentTypePresentation | |
description: | presentation properties of the content type | |
layout* | string Enum: | |
fields | list of fields of this content type ContentTypeField | |
description: | list of fields of this content type | |
type* | string | |
oneOf -> | FieldGroupContentTypeField (details provided in Table A) | |
SelectableFieldGroupContentTypeField (details provided in Table B) | ||
system | System | system properties |
description: | string | |
system | createdBy | string |
createdAt | string($date-time) | |
updatedBy | string | |
updatedAt | string($date-time) |
Table A
FieldGroupContentTypeField | ||
---|---|---|
fieldGroupType* | string |
Table B
SelectableFieldGroupContentTypeField | ||
---|---|---|
fieldGroupTypes* | [ string ] |
ContentTypeField
description: | list of fields of this content type | |
---|---|---|
type* | string | |
oneOf -> | FieldGroupContentTypeField | |
fieldGroupType* | string | |
SelectableFieldGroupContentTypeField | ||
fieldGroupTypes* | [ string ] |
ContentTypeFieldPresentation
description: | presentation properties of the field | |
---|---|---|
caption* | string | |
hint* | string | |
layoutColumn | integer($int32) | |
oneOf -> | StringFieldPresentation | |
caption* | string | |
hint* | string | |
layoutColumn | integer($int32) | |
displayType* | string Enum: | |
BooleanRadioGroupFieldPresentation | ||
caption* | string | |
hint* | string | |
layoutColumn | integer($int32) | |
displayType* | string Enum: | |
orientation | string Enum: | |
LinkFieldPresentation | ||
caption* | string | |
hint* | string | |
layoutColumn | integer($int32) | |
lookupFolderPath | string | |
lastVisitedNodetypes | [ string ] | |
languageContextAware | boolean | |
pickerType | string | |
displayType* | string Enum: | |
lookupFolderTypes | [ string ] | |
lastVisitedKey | string | |
lastVisitedEnabled | boolean | |
ImageLinkFieldPresentation | ||
caption* | string | |
hint* | string | |
layoutColumn | integer($int32) | |
uploadEnabled | boolean | |
displayType* | string Enum: | |
lookupFolderTypes | [ string ] | |
lastVisitedKey | string | |
lastVisitedEnabled | boolean | |
DateFieldPresentation | ||
caption* | string | |
hint* | string | |
layoutColumn | integer($int32) | |
timeSelectable | boolean | |
HtmlFieldPresentation | ||
caption* | string | |
hint* | string | |
layoutColumn | integer($int32) | |
ckEditorAppendedJson | string | |
ckEditorOverlayedJson | string | |
RichTextFieldPresentation | ||
caption* | string | |
hint* | string | |
layoutColumn | integer($int32) | |
ckEditorAppendedJson | string | |
ckEditorOverlayedJson | string | |
imagepickerBasePath | string | |
imagepickerType | string | |
imagepickerNodetypes | [ string ] | |
imagepickerLastVisitedEnabled | boolean | |
imagepickerLastVisitedGroupKey | string | |
imagepickerLastVisitedNodetypes | [ string ] | |
imagepickerPreferredImageVariant | string | |
linkpickerBasePath | string | |
linkpickerType | string | |
linkpickerNodetypes | [ string ] | |
linkpickerLastVisitedEnabled | boolean | |
linkpickerLastVisitedGroupKey | string | |
linkpickerLastVisitedNodetypes | [ string ] | |
linkPickerLanguageContextAware | boolean | |
linkPickerOpenInNewWindowEnabled | boolean | |
includeImageVariants | [ string ] | |
excludeImageVariants | [ string ] | |
DropdownFieldPresentation | ||
caption* | string | |
hint* | string | |
layoutColumn | integer($int32) | |
displayType* | string Enum: | |
sortOrder | string Enum: | |
sortBy | string Enum: | |
showDefault | boolean | |
MultiSelectFieldPresentation | ||
caption* | string | |
hint* | string | |
layoutColumn | integer($int32) | |
displayType* | string Enum: | |
multiSelectType | string Enum: | |
maxRowWithoutScrollbar | integer($int32) | |
multiSelectAllowOrder | boolean | |
RadioGroupFieldPresentation | ||
caption* | string | |
hint* | string | |
layoutColumn | integer($int32) | |
displayType* | string Enum: | |
orientation | string Enum: | |
sortOrder | string Enum: | |
sortBy | string Enum: | |
SelectableFieldGroupPresentation | ||
caption* | string | |
hint* | string | |
layoutColumn | integer($int32) | |
contentPickerType* | string Enum: | |
showFieldGroupNames* | boolean | |
OpenUiExtensionFieldPresentation | ||
caption* | string | |
hint* | string | |
layoutColumn | integer($int32) | |
extensionType | string |
ContentTypeFieldValidations
description: | validations of the field | ||
---|---|---|---|
oneOf -> | StringFieldValidations | ||
maxLength | integer($int32) | ||
maxRow | integer($int32) | ||
DropdownFieldValdations | |||
inResourceBundle | string | ||
inValues | readOnly: true KeyLabe | ||
description: | inValues validation of the field. Expects an array of key-label values | ||
key* | string | ||
label* | string | ||
MultiSelectAndRadioGroupFieldsValidations | |||
inResourceBundle | string | ||
SelectableFieldGroupFieldValdations | |||
maxItem | integer($int32) | ||
TaxonomyFieldValdations | |||
inTaxonomy | string |
ContentTypePresentation
description: | presentation properties of the content type |
layout* | string readOnly: true the layout of the content typeValid values: one-column, two-column, three-column, horizontal, two-column-mirrored Enum: [ one-column, two-column, three-column, horizontal, two-column-mirrored ] |
DateFieldPresentation
caption* | string the caption used for this field in UIs |
hint* | string the hint used for this field in UIs |
layoutColumn | integer($int32) layoutColumn index used for positioning the field |
timeSelectable | boolean Defines if the time is also selectable for Date field. |
FieldValue
description: | default value of this field | ||
---|---|---|---|
oneOf -> | string | ||
filename* | string | ||
binarydata* | string | ||
mimeType* | string | ||
SelectableFieldGroupFieldValue | |||
fields* | description: | fields from FieldGroup or SelectableFieldGroup | |
< * >: | [ { | ||
fieldGroupType* | string | ||
FieldGroupFieldValue | |||
fields* | description: | fields from FieldGroup or SelectableFieldGroup | |
< * >: | [ { |
DropdownFieldPresentation
caption* | string the caption used for this field in UIs |
hint* | string the hint used for this field in UIs |
layoutColumn | integer($int32) layoutColumn index used for positioning the field |
displayType* | string readOnly: true display type of the field. Valid values: RadioGroup, Dropdown, MultiSelect Enum: [ Simple, Text, Checkbox, RadioGroup, Dropdown, MultiSelect, AnyLink, ImageLink ] |
sortOrder | string readOnly: true sortOrder type of the field. Valid values: ascending, descending Enum: [ ascending, descending ] |
sortBy | string readOnly: true sortBy type of the field. Valid values: key, label Enum: [ key, label ] |
showDefault | boolean readOnly: true showDefault type of the field. |
DropdownFieldValdations
inResourceBundle | string | |
---|---|---|
inValues | readOnly: true KeyLabel | |
description: | inValues validation of the field. Expects an array of key-label values | |
key* | string | |
label* | string |
EmbeddedResourceFieldValue
filename* | string the name of the file that is used as default value |
binarydata* | string the binary data of the file that is used as default value. This data has to be encoded using base64 |
mimeType* | string the mimeType of the file to be uploaded |
FieldGroupContentTypeField
description: | list of fields of this content type | |
---|---|---|
type* | string | |
fieldGroupType* | string | |
oneOf -> | SelectableFieldGroupContentTypeField | |
fieldGroupTypes* | [ string ] |
FieldGroupFieldValue
fields* | description: | fields from FieldGroup or SelectableFieldGroup | |
---|---|---|---|
< * >: | fields from FieldGroup or SelectableFieldGroup FieldValue | ||
description: | default value of this field (details provided in Table A and Table B) | ||
oneOf -> | string |
Table A
EmbeddedResourceFieldValue | ||
---|---|---|
filename* | string | |
binarydata* | string | |
mimeType* | string |
Table B
SelectableFieldGroupFieldValue | ||
---|---|---|
fields* | description: | fields from FieldGroup or SelectableFieldGroup |
< * >: | [ { | |
fieldGroupType* | string |
HtmlFieldPresentation
caption* | string the caption used for this field in UIs |
hint* | string the hint used for this field in UIs |
layoutColumn | integer($int32) layoutColumn index used for positioning the field |
ckEditorAppendedJson | string readOnly: true ckEditorAppendedJson property of the field |
ckEditorOverlayedJson | string readOnly: true ckEditorOverlayedJson property of the field |
ImageLinkFieldPresentation
caption* | string the caption used for this field in UIs |
hint* | string the hint used for this field in UIs |
layoutColumn | integer($int32) layoutColumn index used for positioning the field |
uploadEnabled | boolean the uploadEnabled used for this field in UIs |
displayType* | string readOnly: true display type of the field. Valid values: AnyLink, ImageLink Enum: [ Simple, Text, Checkbox, RadioGroup, Dropdown, MultiSelect, AnyLink, ImageLink ] |
lookupFolderTypes | [ the lookupFolderTypes used for this field in UIs string the lookupFolderTypes used for this field in UIs ] |
lastVisitedKey | string the lastVisitedKey used for this field in UIs |
lastVisitedEnabled | boolean the lastVisitedEnabled used for this field in UIs |
KeyLabel
description: | inValues validation of the field. Expects an array of key-label values |
key* | string readOnly: true key validation of the field. Expects a string value |
label* | string readOnly: true label validation of the field. Expects a string value |
LinkFieldPresentation
caption* | string the caption used for this field in UIs |
hint* | string the hint used for this field in UIs |
layoutColumn | integer($int32) layoutColumn index used for positioning the field |
lookupFolderPath | string the lookupFolderPath used for this field in UIs |
lastVisitedNodetypes | [ the lastVisitedNodetypes used for this field in UIs string the lastVisitedNodetypes used for this field in UIs ] |
languageContextAware | boolean the languageContextAware used for this field in UIs |
pickerType | string readOnly: true pickerType property of the field |
displayType* | string readOnly: true display type of the field. Valid values: AnyLink, ImageLink Enum: [ Simple, Text, Checkbox, RadioGroup, Dropdown, MultiSelect, AnyLink, ImageLink ] |
lookupFolderTypes | [ the lookupFolderTypes used for this field in UIs string the lookupFolderTypes used for this field in UIs ] |
lastVisitedKey | string the lastVisitedKey used for this field in UIs |
lastVisitedEnabled | boolean the lastVisitedEnabled used for this field in UIs |
MultiSelectAndRadioGroupFieldsValidations
inResourceBundle | string readOnly: true Id of a resource bundle that is used to fetch values |
MultiSelectFieldPresentation
caption* | string the caption used for this field in UIs |
hint* | string the hint used for this field in UIs |
layoutColumn | integer($int32) layoutColumn index used for positioning the field |
displayType* | string readOnly: true display type of the field. Valid values: RadioGroup, Dropdown, MultiSelect Enum: [ Simple, Text, Checkbox, RadioGroup, Dropdown, MultiSelect, AnyLink, ImageLink ] |
multiSelectType | string readOnly: true multiSelectType type of the field. Enum: [ selectlist, checkboxes, palette ] |
maxRowWithoutScrollbar | integer($int32) readOnly: true maxRowWithoutScrollbar type of the field. |
multiSelectAllowOrder | boolean readOnly: true multiSelectAllowOrder type of the field. |
OpenUiExtensionFieldPresentation
caption* | string the caption used for this field in UIs |
hint* | string the hint used for this field in UIs |
layoutColumn | integer($int32) layoutColumn index used for positioning the field |
extensionType | string Defines an extension way with a string value |
RadioGroupFieldPresentation
caption* | string the caption used for this field in UIs |
hint* | string the hint used for this field in UIs |
layoutColumn | integer($int32) layoutColumn index used for positioning the field |
displayType* | string readOnly: true display type of the field. Valid values: RadioGroup, Dropdown, MultiSelect Enum: [ Simple, Text, Checkbox, RadioGroup, Dropdown, MultiSelect, AnyLink, ImageLink ] |
orientation | string readOnly: true orientation type of the field. Enum: [ vertical, horizontal ] |
sortOrder | string readOnly: true sortOrder type of the field. Enum: [ ascending, descending ] |
sortBy | string readOnly: true sortBy type of the field. Enum: [ key, label ] |
RichTextFieldPresentation
caption* | string the caption used for this field in UIs |
hint* | string the hint used for this field in UIs |
layoutColumn | integer($int32) layoutColumn index used for positioning the field |
ckEditorAppendedJson | string readOnly: true ckEditorAppendedJson property of the field |
ckEditorOverlayedJson | string readOnly: true ckEditorOverlayedJson property of the field |
imagepickerBasePath | string readOnly: true imagepickerBasePath property of the field |
imagepickerType | string readOnly: true imagepickerType property of the field |
imagepickerNodetypes | [ readOnly: true imagepickerNodetypes property of the field string readOnly: true imagepickerNodetypes property of the field ] |
imagepickerLastVisitedEnabled | boolean readOnly: true imagepickerLastVisitedEnabled property of the field |
imagepickerLastVisitedGroupKey | string readOnly: true imagepickerLastVisitedGroupKey property of the field |
imagepickerLastVisitedNodetypes | [ readOnly: true imagepickerLastVisitedNodetypes property of the field string readOnly: true imagepickerLastVisitedNodetypes property of the field ] |
imagepickerPreferredImageVariant | string readOnly: true imagepickerPreferredImageVariant property of the field |
linkpickerBasePath | string readOnly: true linkpickerBasePath property of the field |
linkpickerType | string readOnly: true linkpickerType property of the field |
linkpickerNodetypes | [ readOnly: true linkpickerNodetypes property of the field string readOnly: true linkpickerNodetypes property of the field ] |
linkpickerLastVisitedEnabled | boolean readOnly: true linkpickerLastVisitedEnabled property of the field |
linkpickerLastVisitedGroupKey | string readOnly: true linkpickerLastVisitedGroupKey property of the field |
linkpickerLastVisitedNodetypes | [ readOnly: true linkpickerLastVisitedNodetypes property of the field string readOnly: true linkpickerLastVisitedNodetypes property of the field ] |
linkPickerLanguageContextAware | boolean readOnly: true linkPickerLanguageContextAware property of the field |
linkPickerOpenInNewWindowEnabled | boolean readOnly: true linkPickerOpenInNewWindowEnabled property of the field |
includeImageVariants | [ readOnly: true includeImageVariants property of the field string readOnly: true includeImageVariants property of the field ] |
excludeImageVariants | [ readOnly: true excludeImageVariants property of the field string readOnly: true excludeImageVariants property of the field ] |
SelectableFieldGroupContentTypeField
description: | list of fields of this content type | |
---|---|---|
type* | string | |
fieldGroupTypes* | [ string ] | |
oneOf -> | FieldGroupContentTypeField | |
fieldGroupType* | string |
SelectableFieldGroupFieldValue
fields* | description: | fields from FieldGroup or SelectableFieldGroup | |
---|---|---|---|
< * >: | fields from FieldGroup or SelectableFieldGroup | ||
description: | default value of this field (details provided in Table A and B) | ||
oneOf -> | string | ||
fieldGroupType* | string |
Table A
EmbeddedResourceFieldValue | ||
---|---|---|
filename* | string | |
binarydata* | string | |
mimeType* | string |
Table B
FieldGroupFieldValue | ||
---|---|---|
fields* | description: | fields from FieldGroup or SelectableFieldGroup |
< * >: | [ { |
SelectableFieldGroupFieldValdations
maxItem | integer($int32) readOnly: true maxItem validation of the field. Expects an integer value |
SelectableFieldGroupPresentation
caption* | string the caption used for this field in UIs |
hint* | string the hint used for this field in UIs |
layoutColumn | integer($int32) layoutColumn index used for positioning the field |
contentPickerType* | string readOnly: true 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. Enum: [ links, dropdown ] |
showFieldGroupNames* | boolean readOnly: true 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. |
StringFieldPresentation
caption* | string the caption used for this field in UIs |
hint* | string the hint used for this field in UIs |
layoutColumn | integer($int32) layoutColumn index used for positioning the field |
displayType* | string readOnly: true display type of the field. Valid values: Simple, Text Enum: [ Simple, Text, Checkbox, RadioGroup, Dropdown, MultiSelect, AnyLink, ImageLink ] |
StringFieldValidations
maxLength | integer($int32) readOnly: true maxLength validation of the field. Expects an integer value |
maxRow | integer($int32) readOnly: true maxRow validation of the field. Expects an integer value |
System
description: | system properties |
createdBy | string |
createdAt | string($date-time) |
updatedBy | string |
updatedAt | string($date-time) |
TaxonomyFieldValdations
inTaxonomy | string readOnly: true The taxonomy name. Expects a string value |