1. Types
  2. vapi
  3. metadata
  4. metamodel

vapi metadata metamodel: enumeration value info

The enumeration_value_info structure describes the enumeration value in the enumerated type.

Representation:

{
    "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
value string Value in the enumerated type. All the characters in the string are capitalized.
metadata list Additional metadata for enumeration value in the enumerated type. 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 value. It can contain HTML markup and documentation tags (similar to Javadoc tags). The first statement will be a noun or verb phrase that describes the purpose of the enumeration value.