REST API - enumeration

vapi metadata metamodel: enumeration info

The enumeration_info structure contains the metamodel information of an enumeration element.

Representation:

JSON
LEGACY JSON

{
    "metadata" : {
        "<string>" : {
            "elements" : {
                "<string>" : {
                    "list_value" : [
                        "string",
                        "string"
                    ],
                    "string_value" : "string",
                    "structure_id" : "obj-103",
                    "type" : "LONG",
                    "structure_ids" : [
                        "obj-103",
                        "obj-103"
                    ],
                    "long_value" : 1
                }
            }
        }
    },
    "values" : [
        {
            "metadata" : {
                "<string>" : {
                    "elements" : {
                        "<string>" : {
                            "list_value" : [
                                "string",
                                "string"
                            ],
                            "string_value" : "string",
                            "structure_id" : "obj-103",
                            "type" : "LONG",
                            "structure_ids" : [
                                "obj-103",
                                "obj-103"
                            ],
                            "long_value" : 1
                        }
                    }
                }
            },
            "documentation" : "string",
            "value" : "string"
        },
        {
            "metadata" : {
                "<string>" : {
                    "elements" : {
                        "<string>" : {
                            "list_value" : [
                                "string",
                                "string"
                            ],
                            "string_value" : "string",
                            "structure_id" : "obj-103",
                            "type" : "LONG",
                            "structure_ids" : [
                                "obj-103",
                                "obj-103"
                            ],
                            "long_value" : 1
                        }
                    }
                }
            },
            "documentation" : "string",
            "value" : "string"
        }
    ],
    "documentation" : "string",
    "name" : "string"
}

{
    "metadata" : [
        {
            "value" : {
                "elements" : [
                    {
                        "value" : {
                            "list_value" : [
                                "string",
                                "string"
                            ],
                            "string_value" : "string",
                            "structure_id" : "obj-103",
                            "type" : "LONG",
                            "structure_ids" : [
                                "obj-103",
                                "obj-103"
                            ],
                            "long_value" : 1
                        },
                        "key" : "string"
                    }
                ]
            },
            "key" : "string"
        }
    ],
    "values" : [
        {
            "metadata" : [
                {
                    "value" : {
                        "elements" : [
                            {
                                "value" : {
                                    "list_value" : [
                                        "string",
                                        "string"
                                    ],
                                    "string_value" : "string",
                                    "structure_id" : "obj-103",
                                    "type" : "LONG",
                                    "structure_ids" : [
                                        "obj-103",
                                        "obj-103"
                                    ],
                                    "long_value" : 1
                                },
                                "key" : "string"
                            }
                        ]
                    },
                    "key" : "string"
                }
            ],
            "documentation" : "string",
            "value" : "string"
        },
        {
            "metadata" : [
                {
                    "value" : {
                        "elements" : [
                            {
                                "value" : {
                                    "list_value" : [
                                        "string",
                                        "string"
                                    ],
                                    "string_value" : "string",
                                    "structure_id" : "obj-103",
                                    "type" : "LONG",
                                    "structure_ids" : [
                                        "obj-103",
                                        "obj-103"
                                    ],
                                    "long_value" : 1
                                },
                                "key" : "string"
                            }
                        ]
                    },
                    "key" : "string"
                }
            ],
            "documentation" : "string",
            "value" : "string"
        }
    ],
    "documentation" : "string",
    "name" : "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.
-.values[].value	string	Value in the enumerated type. All the characters in the string are capitalized.
-.values[].metadata	object	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. Object with element values of type element_map.
-.values[].metadata.*	element_map
-.values[].metadata.*.elements	object	Metamodel information of the metadata elements. The key parameter of the key/value pairs is the identifier for the element and the value corresponds to the element value. Object with element values of type element_value.
-.values[].metadata..elements.	element_value
-.values[].metadata..elements..type	string	Type of the value. Defines the valid types for values in metadata elements. Value is one of: LONG: Indicates the type of the value is a long (64 bit signed integer). STRING: Indicates the type of the value is a string (a variable length sequence of characters). The encoding is UTF-8. STRING_LIST: Indicates the type of the value is a list of strings. STRUCTURE_REFERENCE: Indicates the type of the value is an identifier for a structure element. STRUCTURE_REFERENCE_LIST: Indicates the type of the value is a list of identifiers for a structure element.
-.metadata	object	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. Object with element values of type 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.
Optional
-.values[].metadata..elements..long_value	long	Long value of the metadata element. Optional. It is only relevant when type has value LONG. This field is optional and it is only relevant when the value of `type` is LONG.
-.values[].metadata..elements..string_value	string	String value of the metadata element. Optional. It is only relevant when type has value STRING. This field is optional and it is only relevant when the value of `type` is STRING.
-.values[].metadata..elements..list_value	string[]	List of strings value of the metadata element. Optional. It is only relevant when type has value STRING_LIST. This field is optional and it is only relevant when the value of `type` is STRING_LIST.

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.
values[].value	string	Value in the enumerated type. All the characters in the string are capitalized.
values[].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}
values[].metadata[].key	string
values[].metadata[].value	element_map
values[].metadata[].value.elements	list	Metamodel information of the metadata elements. The key parameter of the key/value pairs is the identifier for the element and the value corresponds to the element value. List of {"key": string, "value": element_value}
values[].metadata[].value.elements[].key	string
values[].metadata[].value.elements[].value	element_value
values[].metadata[].value.elements[].value.type	string	Type of the value. Defines the valid types for values in metadata elements. Value is one of: LONG: Indicates the type of the value is a long (64 bit signed integer). STRING: Indicates the type of the value is a string (a variable length sequence of characters). The encoding is UTF-8. STRING_LIST: Indicates the type of the value is a list of strings. STRUCTURE_REFERENCE: Indicates the type of the value is an identifier for a structure element. STRUCTURE_REFERENCE_LIST: Indicates the type of the value is a list of identifiers for a structure element.
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.
Optional
values[].metadata[].value.elements[].value.long_value	long	Long value of the metadata element. Optional. It is only relevant when type has value LONG. This field is optional and it is only relevant when the value of `type` is LONG.
values[].metadata[].value.elements[].value.string_value	string	String value of the metadata element. Optional. It is only relevant when type has value STRING. This field is optional and it is only relevant when the value of `type` is STRING.
values[].metadata[].value.elements[].value.list_value	string[]	List of strings value of the metadata element. Optional. It is only relevant when type has value STRING_LIST. This field is optional and it is only relevant when the value of `type` is STRING_LIST.