1. Operations
  2. vapi
  3. metadata
  4. metamodel
  5. enumeration

vapi metadata metamodel enumeration: get

Retrieves information about the enumeration element corresponding to enumeration_id.

The vapi.metadata.metamodel.enumeration_info contains the metamodel information about the enumeration value element contained in the enumeration element.

Request:

HTTP request

GET https://{server}/rest/com/vmware/vapi/metadata/metamodel/enumeration/id:{enumeration_id}

Path Parameters

Name Type Description
Required
enumeration_id string Identifier of the enumeration element.

Response:

HTTP Status Code: 200

Representations:

{
    "value": {
        "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"
                            }
                        }
                    ]
                }
            }
        ],
        "name": "string",
        "values": [
            {
                "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"
            },
            {
                "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"
            }
        ]
    }
}
<?xml version="1.0" ?>
<ns0:Get-Result xmlns:ns0="http://vmware.com/vapi/metadata/metamodel/enumeration" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <value>
    <values-array>
      <array-item>
        <documentation>string</documentation>
        <value>string</value>
        <metadata-array>
          <array-item>
            <value>
              <elements-array>
                <array-item>
                  <value>
                    <long_value>1</long_value>
                    <list_value-array>
                      <array-item>string</array-item>
                      <array-item>string</array-item>
                    </list_value-array>
                    <structure_id>obj-103</structure_id>
                    <structure_ids-array>
                      <array-item>obj-103</array-item>
                      <array-item>obj-103</array-item>
                    </structure_ids-array>
                    <string_value>string</string_value>
                    <type>LONG</type>
                  </value>
                  <key>string</key>
                </array-item>
              </elements-array>
            </value>
            <key>string</key>
          </array-item>
        </metadata-array>
      </array-item>
      <array-item>
        <documentation>string</documentation>
        <value>string</value>
        <metadata-array>
          <array-item>
            <value>
              <elements-array>
                <array-item>
                  <value>
                    <long_value>1</long_value>
                    <list_value-array>
                      <array-item>string</array-item>
                      <array-item>string</array-item>
                    </list_value-array>
                    <structure_id>obj-103</structure_id>
                    <structure_ids-array>
                      <array-item>obj-103</array-item>
                      <array-item>obj-103</array-item>
                    </structure_ids-array>
                    <string_value>string</string_value>
                    <type>LONG</type>
                  </value>
                  <key>string</key>
                </array-item>
              </elements-array>
            </value>
            <key>string</key>
          </array-item>
        </metadata-array>
      </array-item>
    </values-array>
    <name>string</name>
    <documentation>string</documentation>
    <metadata-array>
      <array-item>
        <value>
          <elements-array>
            <array-item>
              <value>
                <long_value>1</long_value>
                <list_value-array>
                  <array-item>string</array-item>
                  <array-item>string</array-item>
                </list_value-array>
                <structure_id>obj-103</structure_id>
                <structure_ids-array>
                  <array-item>obj-103</array-item>
                  <array-item>obj-103</array-item>
                </structure_ids-array>
                <string_value>string</string_value>
                <type>LONG</type>
              </value>
              <key>string</key>
            </array-item>
          </elements-array>
        </value>
        <key>string</key>
      </array-item>
    </metadata-array>
  </value>
</ns0:Get-Result>

Response Type:

Name Type Description
bold = required
value enumeration_info The vapi.metadata.metamodel.enumeration_info instance that corresponds to enumeration_id.
value.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.
value.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.
value.values[].value string Value in the enumerated type. All the characters in the string are capitalized.
value.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}
value.values[].metadata[].key string
value.values[].metadata[].value element_map
value.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}
value.values[].metadata[].value.elements[].key string
value.values[].metadata[].value.elements[].value element_value
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.
value.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.
value.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.
value.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.
value.values[].metadata[].value.elements[].value.structure_id string Identifier of the structure element.

Optional. It is only relevant when type has value STRUCTURE_REFERENCE. This field is optional and it is only relevant when the value of type is STRUCTURE_REFERENCE.When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.vapi.structure. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.vapi.structure.
value.values[].metadata[].value.elements[].value.structure_ids string[] List of identifiers of the structure elements.

Optional. It is only relevant when type has value STRUCTURE_REFERENCE_LIST. This field is optional and it is only relevant when the value of type is STRUCTURE_REFERENCE_LIST.When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: com.vmware.vapi.structure. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: com.vmware.vapi.structure.
value.values[].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.
value.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}
value.metadata[].key string
value.metadata[].value element_map
value.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}
value.metadata[].value.elements[].key string
value.metadata[].value.elements[].value element_value
value.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.
value.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.
value.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.
value.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.
value.metadata[].value.elements[].value.structure_id string Identifier of the structure element.

Optional. It is only relevant when type has value STRUCTURE_REFERENCE. This field is optional and it is only relevant when the value of type is STRUCTURE_REFERENCE.When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.vapi.structure. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.vapi.structure.
value.metadata[].value.elements[].value.structure_ids string[] List of identifiers of the structure elements.

Optional. It is only relevant when type has value STRUCTURE_REFERENCE_LIST. This field is optional and it is only relevant when the value of type is STRUCTURE_REFERENCE_LIST.When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: com.vmware.vapi.structure. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: com.vmware.vapi.structure.
value.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.

Errors:

HTTP Status Code Type Description
404 not_found if the enumeration element associated with enumeration_id is not contained in any of the package elements, service elements and structure elements.