This API has a deprecated equivalent from v7.0U1.
Get Metamodel Enumeration
Retrieves information about the enumeration element corresponding to enumerationId. The EnumerationInfo contains the metamodel information about the enumeration value element contained in the enumeration element.
Request
URLURL
https://{api_host}/api/vapi/metadata/metamodel/enumeration/{enumeration_id}
Path Parameters
Path Parameters
string
enumeration_id
Required
Identifier of the enumeration element. The parameter must be an identifier for the resource type: com.vmware.vapi.enumeration.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
MetadataMetamodelEnumerationInfo
of type application/json
The EnumerationInfo instance that corresponds to enumerationId
{
"documentation": "string",
"metadata": {
"key": {
"elements": {
"key": {
"list_value": [
"string"
],
"long_value": 0,
"string_value": "string",
"structure_id": "string",
"structure_ids": [
"string"
],
"type": "LONG"
}
}
}
},
"name": "string",
"values": [
{
"documentation": "string",
"metadata": {
"key": {
"elements": {
"key": {
"list_value": [
"string"
],
"long_value": 0,
"string_value": "string",
"structure_id": "string",
"structure_ids": [
"string"
],
"type": "LONG"
}
}
}
},
"value": "string"
}
]
}
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.
map of
MetadataMetamodelElementMap
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 MetadataIdentifier contains possible string values for keys in the map.
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.
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.
Errors
404
com.vmware.vapi.std.errors.not_found : if the enumeration element associated with enumerationId is not contained in any of the package elements, service elements and structure elements.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
Invoke-GetEnumerationIdMetamodel -EnumerationId "MyEnumerationId"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vapi/metadata/metamodel/enumeration/{enumeration_id}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: get
x-vmw-doc-deprecated-path: /rest/com/vmware/vapi/metadata/metamodel/enumeration/id:{enumeration_id}
x-vmw-doc-operation: get
Availability
Added in 7.0U2
