Skip to main content

Substructure (object)

{
"fields": {
"name": { "…": "as before" },
"age": { "…": "as before" },
"married": { "…": "as before" },
"email": { "…": "as before" },
"address": {
"cms": {
"column": true
},
"optional": true,
"properties": {
"city": {
"cms": {
"column": true
},
"optional": true,
"type": "string"
},
"street": {
"optional": true,
"type": "string"
},
"postalcode": {
"optional": true,
"type": "string"
}
},
"strict": true,
"type": "object"
}
}
}

The voluntary (optional) field address is a substructure with the subfields city, street and postalcode, all optional strings. No other fields are allowed (strict). Only city appears in the list. column on a subfield only takes effect if it is also set on the substructure itself.

Form

List

Parameters​

ParameterMeaning
propertiessubfields, structured like fields
strictallow no subfields other than those described
optionalfield may be missing (default false)
localizableentire substructure per language, see Multilingual content

When modifying a record via PUT, a substructure must always be transmitted in full.