REST API - field

vapi metadata metamodel: field info

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

Representation:

JSON

{
    "documentation": "string",
    "metadata": [
        {
            "key": "string",
            "value": {
                "elements": [
                    {
                        "key": "string",
                        "value": {
                            "list_value": [
                                "string",
                                "string"
                            ],
                            "long_value": 1,
                            "string_value": "string",
                            "structure_id": "obj-103",
                            "structure_ids": [
                                "obj-103",
                                "obj-103"
                            ],
                            "type": "LONG"
                        }
                    }
                ]
            }
        }
    ],
    "name": "string",
    "type": {
        "builtin_type": "VOID",
        "category": "BUILTIN",
        "generic_instantiation": {
            "element_type": {
                "builtin_type": "VOID",
                "category": "BUILTIN",
                "generic_instantiation": {
                    "generic_type": "LIST"
                },
                "user_defined_type": {
                    "resource_id": "obj-103",
                    "resource_type": "string"
                }
            },
            "generic_type": "LIST"
        },
        "user_defined_type": {
            "resource_id": "obj-103",
            "resource_type": "string"
        }
    }
}

Attributes:

Name	Type	Description
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.
type	type	Type information.
metadata	list	Generic metadata elements for the field element. The key in the key/value pairs is the name of the metadata element and the value is the data associated with that metadata element. The vapi.metadata.metamodel.metadata_identifier contains possible string values for keys in the key/value pairs. List of {"key": string, "value": element_map}
documentation	string	English language documentation for the service element. It can contain HTML markup and Javadoc tags.