Vapi Metadata Metamodel Enumeration get

Vapi Metadata Metamodel Enumeration get

Retrieves information about the enumeration element corresponding to enumerationId.

The Vapi Metadata Metamodel EnumerationInfo contains the metamodel information about the enumeration value element contained in the enumeration element.

Request
URI
GET
https://{api_host}/api/vapi/metadata/metamodel/enumeration/{enumerationId}
COPY
Path Parameters
string
enumerationId
Required

Identifier of the enumeration element.

The parameter must be an identifier for the resource type: com.vmware.vapi.enumeration.


Authentication
This operation uses the following authentication methods.
Responses
200

The Vapi Metadata Metamodel EnumerationInfo instance that corresponds to enumerationId

Returns Vapi Metadata Metamodel EnumerationInfo of type(s) application/json
{
    "name": "string",
    "values": [
        {
            "value": "string",
            "metadata": {
                "metadata": {
                    "elements": {
                        "elements": {
                            "type": "string",
                            "long_value": 0,
                            "string_value": "string",
                            "list_value": [
                                "string"
                            ],
                            "structure_id": "string",
                            "structure_ids": [
                                "string"
                            ]
                        }
                    }
                }
            },
            "documentation": "string"
        }
    ],
    "metadata": {
        "metadata": {
            "elements": {
                "elements": {
                    "type": "string",
                    "long_value": 0,
                    "string_value": "string",
                    "list_value": [
                        "string"
                    ],
                    "structure_id": "string",
                    "structure_ids": [
                        "string"
                    ]
                }
            }
        }
    },
    "documentation": "string"
}
string
name
Required

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.

array of object
values
Required

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.

object
metadata
Required

Generic metadata elements for an enumeration 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 Vapi Metadata Metamodel MetadataIdentifier contains possible string values for keys in the map.

string
documentation
Required

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.


404

if the enumeration element associated with enumerationId is not contained in any of the package elements, service elements and structure elements.

Returns Vapi Std Errors NotFound of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors NotFound0
"Vapi Std Errors NotFound Object"

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/vapi/metadata/metamodel/enumeration/{enumerationId}