com.vmware.vapi.metadata.metamodel.enumeration

The enumeration service provides operations to retrieve metamodel information about an enumeration element in the interface definition language.

The enumeration has a list of enumeration value elements.

get

GET /com/vmware/vapi/metadata/metamodel/enumeration/id:{enumeration_id}
POST /com/vmware/vapi/metadata/metamodel/enumeration/id:{enumeration_id}?~action=get
POST /com/vmware/vapi/metadata/metamodel/enumeration?~action=get

Retrieves information about the enumeration element corresponding to enumeration_id.

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

Request:
Representations:
{
    "enumeration_id": "obj-103"
}
<?xml version="1.0" ?>
<ns0:Get-Input xmlns:ns0="http://vmware.com/vapi/metadata/metamodel/enumeration" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <enumeration_id>obj-103</enumeration_id>
</ns0:Get-Input>
POST /com/vmware/vapi/metadata/metamodel/enumeration?~action=get
&enumeration_id=obj-103

Parameters:
Name Type Required Description
enumeration_id
 *
 ID Yes Identifier of the enumeration element. Id of type com.vmware.vapi.enumeration.

Response:
Representations:
{
    "value": {
        "documentation": "string",
        "metadata": [
            {
                "key": "string",
                "value": {
                    "elements": [
                        {
                            "key": "string",
                            "value": {
                                "list_value": [
                                    "string",
                                    "string"
                                ],
                                "long_value": 10,
                                "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": 10,
                                        "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": 10,
                                        "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>10</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>10</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>10</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>

Parameters:
Name Type Required Description
result enumeration_info Yes The com.vmware.vapi.metadata.metamodel.enumeration_info instance that corresponds to enumeration_id

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

Copyright © 2014. All Rights Reserved.