Get Metamodel Enumeration
If vSphere APIs begin with /rest, maps are consumed and emitted as lists of objects containing a key:value pair.
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}/rest/com/vmware/vapi/metadata/metamodel/enumeration/id:{enumeration_id}
Path Parameters
Path Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Identifier of the enumeration element. The parameter must be an identifier for the resource type: com.vmware.vapi.enumeration. |
Header Parameters
Header Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Required session ID, obtained by first calling Create Session API |
Response
Response
Response BodyResponse Body
200 OK returns
MetadataMetamodelEnumerationGetResponseBody
of type application/json
The EnumerationInfo instance that corresponds to enumerationId
{
"value": {
"documentation": "string",
"metadata": [
{
"key": "key1",
"value": {
"elements": [
{
"key": "key1",
"value": {
"list_value": [
"string"
],
"long_value": 0,
"string_value": "string",
"structure_id": "string",
"structure_ids": [
"string"
],
"type": "enum"
}
}
]
}
}
],
"name": "string",
"values": [
{
"documentation": "string",
"metadata": [
{
"key": "key1",
"value": {
"elements": [
{
"key": "key1",
"value": {
"list_value": [
"string"
],
"long_value": 0,
"string_value": "string",
"structure_id": "string",
"structure_ids": [
"string"
],
"type": "enum"
}
}
]
}
}
],
"value": "string"
}
]
}
}| Property Name | Type | Description |
|---|---|---|
| value | MetadataMetamodelEnumerationInfo |
The EnumerationInfo instance that corresponds to enumerationId |
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/rest/com/vmware/vapi/metadata/metamodel/enumeration/id:{enumeration_id}
Errors
| Code | Returns | Description |
|---|---|---|
| 404 | ErrorRest | 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 | ErrorRest | Not available |
