The FieldInfo structure contains metamodel information of a field element contained in a structure element.


Required Property Name Type Description
required documentation string

English language documentation for the service element. It can contain HTML markup and Javadoc tags.

required metadata map of MetadataMetamodelElementMap

Generic metadata elements for the field element. The key in the map is the name of the metadata element and the value is the data associated with that metadata element. The MetadataIdentifier contains possible string values for keys in the map.

required name string

Name of the field element in a canonical format. The format is lower case with underscores. Each underscore represents a word boundary. If there are acronyms in the word, the capitalization is preserved. This format makes it easy to translate the segment into a different naming convention.

required type MetadataMetamodelType

Type information.

JSON Example

    "documentation": "string",
    "metadata": {
        "key": {
            "elements": {
                "key": {
                    "type": "enum"
    "name": "string",
    "type": {
        "category": "enum"

Was this page helpful?