Metadata_Metamodel_FieldInfo

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

JSON Example

{
    "name": "string",
    "type": {
        "category": "string",
        "builtin_type": "string",
        "user_defined_type": {
            "resource_type": "string",
            "resource_id": "string"
        },
        "generic_instantiation": {
            "generic_type": "string",
            "element_type": "Metadata_Metamodel_Type Object",
            "map_key_type": "Metadata_Metamodel_Type Object",
            "map_value_type": "Metadata_Metamodel_Type Object"
        }
    },
    "documentation": "string"
}

string

name

Required

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.

Metadata_Metamodel_Type

type

Required

The Type structure describes the type information of a typed element in the interface definiton language. The following elements in the metamodel are typed:

Field element in a structure element. See StructureInfo.fields
Parameter element in an operation element. See OperationInfo.params
Result element in an operation element. See OperationInfo.output The type could be one of the three following categories:
Built-in types: These are types present in the interface definition language type system. They are provided by the infrastructure.
User defined named type: API designers can create custom types and use them for the typed elements. These types have a unique identifier.
Generic type instantiation: The language infrastructure also provides generic types such as list, map, set and so on. An instantiation of one of these generic types could also be used for the typed elements.

object

metadata

Required

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.

string

documentation

Required

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