Skip to main content

Field Properties

SettingTypePurposeLanguage Support
Examplestring
Constantbool
OptionalboolStates if this parameter is optional or not.
IsArraybool
IsMapbool
ArrayDimensionlong?
IsSdlNativeTypebool?This flag decides whether a field is a primitive type or custom type.-
Attributes (DateTime)AttributesThe DateTime format for this field.
ExternalDocumentationExternalDocumentation-
DeprecatedboolThis flag shows whether this field is deprecated or not.
Attributes (Other)AttributesThe constraints for SDLNativeTypes, other than Date and DateTime.-
ArrayAttributesArrayAttributes-
NullableboolIf enabled, field is skipped during JSON serialization.
IsArrayOfMapboolIf enabled, supports array of maps and map of arrays.
ExamplesList<Example>List of examples for this field.-
AnyOfTypesList<TypeDefinition>-
OneOfTypesList<TypeDefinition>-
NotTypesList<TypeDefinition>-
XmlAttributesFieldXmlAttributesSupport for XML attributes for this field.
JsonIdentityJsonIdentity