Schemas

BooleanRadioGroupFieldPresentation

caption*string

the caption used for this field in UIs
hint*string

the hint used for this field in UIs
layoutColumninteger($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 ]
orientationstring
readOnly: true

orientation type of the field.

Enum:
[ vertical, horizontal ]

ContentType

name*string
readOnly: true
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'.
type*string
readOnly: true
the type of the content type (eg Document, FieldGroup) Valid values: Document, FieldGroup

Enum:
[ Document, FieldGroup ]
enabledboolean

whether the content type is enabled, true by default
presentation*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 ]
fieldslist 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)
systemSystemsystem properties
description:string
systemcreatedBystring
createdAtstring($date-time)
updatedBystring
updatedAtstring($date-time)

Table A

FieldGroupContentTypeField
fieldGroupType*string
Identifying name field group type. 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'.

Table B

SelectableFieldGroupContentTypeField
fieldGroupTypes*[
fieldGroupTypes validation of the field. Expects an array of field group names

string
fieldGroupTypes validation of the field. Expects an array of field group names. 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'.

]

ContentTypeField

description:list of fields of this content type
type*string
oneOf ->FieldGroupContentTypeField
fieldGroupType*string
Identifying name field group type. 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'.
SelectableFieldGroupContentTypeField
fieldGroupTypes*[
fieldGroupTypes validation of the field. Expects an array of field group names

string
fieldGroupTypes validation of the field. 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

]

ContentTypeFieldPresentation

description:presentation properties of the field
caption*string
the caption used for this field in UIs
hint*string
the hint used for this field in UIs
layoutColumninteger($int32)
layoutColumn index used for positioning the field
oneOf ->StringFieldPresentation
caption*string
the caption used for this field in UIs
hint*string
the hint used for this field in UIs
layoutColumninteger($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 ]
BooleanRadioGroupFieldPresentation
caption*string
the caption used for this field in UIs
hint*string
the hint used for this field in UIs
layoutColumninteger($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 ]
orientationstring
readOnly: true
orientation type of the field.

Enum:
[ vertical, horizontal ]
LinkFieldPresentation
caption*string
the caption used for this field in UIs
hint*string
the hint used for this field in UIs
layoutColumninteger($int32)
layoutColumn index used for positioning the field
lookupFolderPathstring
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. 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'.

]
languageContextAwareboolean
the languageContextAware used for this field in UIs
pickerTypestring
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

]
lastVisitedKeystring
the lastVisitedKey used for this field in UIs
lastVisitedEnabledboolean
the lastVisitedEnabled used for this field in UIs
ImageLinkFieldPresentation
caption*string
the caption used for this field in UIs
hint*string
the hint used for this field in UIs
layoutColumninteger($int32)
layoutColumn index used for positioning the field
uploadEnabledboolean
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

]
lastVisitedKeystring
the lastVisitedKey used for this field in UIs
lastVisitedEnabledboolean
the lastVisitedEnabled used for this field in UIs
DateFieldPresentation
caption*string
the caption used for this field in UIs
hint*string
the hint used for this field in UIs
layoutColumninteger($int32)
layoutColumn index used for positioning the field
timeSelectableboolean
Defines if the time is also selectable for Date field.
HtmlFieldPresentation
caption*string
the caption used for this field in UIs
hint*string
the hint used for this field in UIs
layoutColumninteger($int32)
layoutColumn index used for positioning the field
ckEditorAppendedJsonstring
readOnly: true
ckEditorAppendedJson property of the field
ckEditorOverlayedJsonstring
readOnly: true
ckEditorOverlayedJson property of the field
RichTextFieldPresentation
caption*string
the caption used for this field in UIs
hint*string
the hint used for this field in UIs
layoutColumninteger($int32)
layoutColumn index used for positioning the field
ckEditorAppendedJsonstring
readOnly: true
ckEditorAppendedJson property of the field
ckEditorOverlayedJsonstring
readOnly: true
ckEditorOverlayedJson property of the field
imagepickerBasePathstring
readOnly: true
imagepickerBasePath property of the field
imagepickerTypestring
readOnly: true
imagepickerType property of the field
imagepickerNodetypes[
readOnly: true
imagepickerNodetypes property of the field

string
readOnly: true
imagepickerNodetypes property of the field. 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'.

]
imagepickerLastVisitedEnabledboolean
readOnly: true
imagepickerLastVisitedEnabled property of the field
imagepickerLastVisitedGroupKeystring
readOnly: true
imagepickerLastVisitedGroupKey property of the field
imagepickerLastVisitedNodetypes[
readOnly: true
imagepickerLastVisitedNodetypes property of the field

string
readOnly: true
imagepickerLastVisitedNodetypes property of the field. 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'.

]
imagepickerPreferredImageVariantstring
readOnly: true
imagepickerPreferredImageVariant property of the field
linkpickerBasePathstring
readOnly: true
linkpickerBasePath property of the field
linkpickerTypestring
readOnly: true
linkpickerType property of the field
linkpickerNodetypes[
readOnly: true
linkpickerNodetypes property of the field

string
readOnly: true
linkpickerNodetypes property of the field. 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'.

]
linkpickerLastVisitedEnabledboolean
readOnly: true
linkpickerLastVisitedEnabled property of the field
linkpickerLastVisitedGroupKeystring
readOnly: true
linkpickerLastVisitedGroupKey property of the field
linkpickerLastVisitedNodetypes[
readOnly: true
linkpickerLastVisitedNodetypes property of the field

string
readOnly: true
linkpickerLastVisitedNodetypes property of the field. 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'.

]
linkPickerLanguageContextAwareboolean
readOnly: true
linkPickerLanguageContextAware property of the field
linkPickerOpenInNewWindowEnabledboolean
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

]
DropdownFieldPresentation
caption*string
the caption used for this field in UIs
hint*string
the hint used for this field in UIs
layoutColumninteger($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 ]
sortOrderstring
readOnly: true
sortOrder type of the field. Valid values: ascending, descending

Enum:
[ ascending, descending ]
sortBystring
readOnly: true
sortBy type of the field. Valid values: key, label

Enum:
[ key, label ]
showDefaultboolean
readOnly: true
showDefault type of the field.
MultiSelectFieldPresentation
caption*string
the caption used for this field in UIs
hint*string
the hint used for this field in UIs
layoutColumninteger($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 ]
multiSelectTypestring
readOnly: true
multiSelectType type of the field.

Enum:
[ selectlist, checkboxes, palette ]
maxRowWithoutScrollbarinteger($int32)
readOnly: true
maxRowWithoutScrollbar type of the field.
multiSelectAllowOrderboolean
readOnly: true
multiSelectAllowOrder type of the field.
RadioGroupFieldPresentation
caption*string
the caption used for this field in UIs
hint*string
the hint used for this field in UIs
layoutColumninteger($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 ]
orientationstring
readOnly: true
orientation type of the field.

Enum:
[ vertical, horizontal ]
sortOrderstring
readOnly: true
sortOrder type of the field.

Enum:
[ ascending, descending ]
sortBystring
readOnly: true
sortBy type of the field.

Enum:
[ key, label ]
SelectableFieldGroupPresentation
caption*string
the caption used for this field in UIs
hint*string
the hint used for this field in UIs
layoutColumninteger($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.
OpenUiExtensionFieldPresentation
caption*string
the caption used for this field in UIs
hint*string
the hint used for this field in UIs
layoutColumninteger($int32)
layoutColumn index used for positioning the field
extensionTypestring
Defines an extension way with a string value

ContentTypeFieldValidations

description:validations of the field
oneOf ->StringFieldValidations
maxLengthinteger($int32)
readOnly: true
maxLength validation of the field. Expects an integer value
maxRowinteger($int32)
readOnly: true
maxRow validation of the field. Expects an integer value
DropdownFieldValdations
inResourceBundlestring
readOnly: true
Id of a resource bundle that is used to fetch values
inValuesreadOnly: true
inValues validation of the field. Expects an array of key-label values

KeyLabe
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
MultiSelectAndRadioGroupFieldsValidations
inResourceBundlestring
readOnly: true
Id of a resource bundle that is used to fetch values
SelectableFieldGroupFieldValdations
maxIteminteger($int32)
readOnly: true
maxItem validation of the field. Expects an integer value
TaxonomyFieldValdations
inTaxonomystring
readOnly: true
The taxonomy name. Expects a string value

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
layoutColumninteger($int32)

layoutColumn index used for positioning the field
timeSelectableboolean

Defines if the time is also selectable for Date field.

FieldValue

description:default value of this field
oneOf ->string
boolean
integer($int64)
number($double)
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
SelectableFieldGroupFieldValue
fields*description:fields from FieldGroup or SelectableFieldGroup
< * >:[
fields from FieldGroup or SelectableFieldGroup

{
}]
fieldGroupType*string
The name of the default value type. 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
fields*description:fields from FieldGroup or SelectableFieldGroup
< * >:[
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
layoutColumninteger($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 ]
sortOrderstring
readOnly: true

sortOrder type of the field. Valid values: ascending, descending

Enum:
[ ascending, descending ]
sortBystring
readOnly: true

sortBy type of the field. Valid values: key, label

Enum:
[ key, label ]
showDefaultboolean
readOnly: true

showDefault type of the field.

DropdownFieldValdations

inResourceBundlestring
readOnly: true
Id of a resource bundle that is used to fetch values
inValuesreadOnly: true
inValues validation of the field. Expects an array of key-label values

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

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
Identifying name field group type. 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'.
oneOf ->SelectableFieldGroupContentTypeField
fieldGroupTypes*[
fieldGroupTypes validation of the field. Expects an array of field group names

string
fieldGroupTypes validation of the field. Expects an array of field group names

]

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
boolean
integer($int64)
number($double)

Table A

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

Table B

SelectableFieldGroupFieldValue
fields*description:fields from FieldGroup or SelectableFieldGroup
< * >:[
fields from FieldGroup or SelectableFieldGroup

{
}]
fieldGroupType*string
The name of the default value type. 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'.

HtmlFieldPresentation

caption*string

the caption used for this field in UIs
hint*string

the hint used for this field in UIs
layoutColumninteger($int32)

layoutColumn index used for positioning the field
ckEditorAppendedJsonstring
readOnly: true

ckEditorAppendedJson property of the field
ckEditorOverlayedJsonstring
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
layoutColumninteger($int32)

layoutColumn index used for positioning the field
uploadEnabledboolean

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

]
lastVisitedKeystring

the lastVisitedKey used for this field in UIs
lastVisitedEnabledboolean

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
layoutColumninteger($int32)

layoutColumn index used for positioning the field
lookupFolderPathstring

the lookupFolderPath used for this field in UIs
lastVisitedNodetypes[

The lastVisitedNodetypes used for this field in UIs. 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'.

string

the lastVisitedNodetypes used for this field in UIs

]
languageContextAwareboolean

the languageContextAware used for this field in UIs
pickerTypestring
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

]
lastVisitedKeystring

the lastVisitedKey used for this field in UIs
lastVisitedEnabledboolean

the lastVisitedEnabled used for this field in UIs

MultiSelectAndRadioGroupFieldsValidations

inResourceBundlestring
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
layoutColumninteger($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 ]
multiSelectTypestring
readOnly: true

multiSelectType type of the field.

Enum:
[ selectlist, checkboxes, palette ]
maxRowWithoutScrollbarinteger($int32)
readOnly: true

maxRowWithoutScrollbar type of the field.
multiSelectAllowOrderboolean
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
layoutColumninteger($int32)

layoutColumn index used for positioning the field
extensionTypestring

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
layoutColumninteger($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 ]
orientationstring
readOnly: true

orientation type of the field.

Enum:
[ vertical, horizontal ]
sortOrderstring
readOnly: true

sortOrder type of the field.

Enum:
[ ascending, descending ]
sortBystring
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
layoutColumninteger($int32)

layoutColumn index used for positioning the field
ckEditorAppendedJsonstring
readOnly: true

ckEditorAppendedJson property of the field
ckEditorOverlayedJsonstring
readOnly: true

ckEditorOverlayedJson property of the field
imagepickerBasePathstring
readOnly: true

imagepickerBasePath property of the field
imagepickerTypestring
readOnly: true

imagepickerType property of the field
imagepickerNodetypes[
readOnly: true

imagepickerNodetypes property of the field

string
readOnly: true

imagepickerNodetypes property of the field. 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'.

]
imagepickerLastVisitedEnabledboolean
readOnly: true

imagepickerLastVisitedEnabled property of the field
imagepickerLastVisitedGroupKeystring
readOnly: true

imagepickerLastVisitedGroupKey property of the field
imagepickerLastVisitedNodetypes[
readOnly: true

imagepickerLastVisitedNodetypes property of the field

string
readOnly: true

imagepickerLastVisitedNodetypes property of the field. 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'.

]
imagepickerPreferredImageVariantstring
readOnly: true

imagepickerPreferredImageVariant property of the field
linkpickerBasePathstring
readOnly: true

linkpickerBasePath property of the field
linkpickerTypestring
readOnly: true

linkpickerType property of the field
linkpickerNodetypes[
readOnly: true

linkpickerNodetypes property of the field

string
readOnly: true

linkpickerNodetypes property of the field. 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'.

]
linkpickerLastVisitedEnabledboolean
readOnly: true

linkpickerLastVisitedEnabled property of the field
linkpickerLastVisitedGroupKeystring
readOnly: true

linkpickerLastVisitedGroupKey property of the field
linkpickerLastVisitedNodetypes[
readOnly: true

linkpickerLastVisitedNodetypes property of the field

string
readOnly: true

linkpickerLastVisitedNodetypes property of the field. 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'.

]
linkPickerLanguageContextAwareboolean
readOnly: true

linkPickerLanguageContextAware property of the field
linkPickerOpenInNewWindowEnabledboolean
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*[
fieldGroupTypes validation of the field. Expects an array of field group names

string
fieldGroupTypes validation of the field. Expects an array of field group names. 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'.

]
oneOf ->FieldGroupContentTypeField
fieldGroupType*string
Identifying name field group type. 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'

SelectableFieldGroupFieldValue

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 B)
oneOf ->string
boolean
integer($int64)
number($double)
fieldGroupType*string
The name of the default value type. 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'.

Table A

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

Table B

FieldGroupFieldValue
fields*description:fields from FieldGroup or SelectableFieldGroup
< * >:[
fields from FieldGroup or SelectableFieldGroup

{
}]

SelectableFieldGroupFieldValdations

maxIteminteger($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
layoutColumninteger($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
layoutColumninteger($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

maxLengthinteger($int32)
readOnly: true

maxLength validation of the field. Expects an integer value
maxRowinteger($int32)
readOnly: true

maxRow validation of the field. Expects an integer value

System

description:system properties
createdBystring
createdAtstring($date-time)
updatedBystring
updatedAtstring($date-time)

TaxonomyFieldValdations

inTaxonomystring
readOnly: true

The taxonomy name. Expects a string value