REST API - enumeration

vapi metadata metamodel: enumeration info

The enumeration_info structure contains the metamodel information of an enumeration 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",
    "values": [
        {
            "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"
                                }
                            }
                        ]
                    }
                }
            ],
            "value": "string"
        },
        {
            "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"
                                }
                            }
                        ]
                    }
                }
            ],
            "value": "string"
        }
    ]
}

Attributes:

Name	Type	Description
Required
name	string	Dot separated name of the enumeration element. The segments in the name reflect the organization of the APIs. The format of each segment 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.
values	enumeration_value_info[]	Metamodel information of all the enumeration value elements contained in this enumeration element. The order of the enumeration value elements in the list is same as the order in which they are defined in the interface definition file.
metadata	list	Generic metadata elements for an enumeration 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 an enumeration element. It can contain HTML markup and Javadoc tags. The first sentence of the enumeration documentation is a complete sentence that identifies the enumeration by name and summarizes the purpose of the enumeration. The documentation describes the context in which the enumeration is used. The documentation also contains references to the context in which the enumeration is used. But if the enumeration is used in many contexts, the references may not be present.