VMware Cloud Director API - Metadata

VMware Cloud Director API - Metadata

MetadataType

Element:
Metadata
Type:
MetadataType
Namespace:
http://www.vmware.com/vcloud/v1.5
Description:
User-defined metadata associated with with an object.
Since:
1.5
Schema:
common.xsd
Media type(s):
application/vnd.vmware.vcloud.metadata+xml
application/vnd.vmware.vcloud.metadata+json
Extends:
ResourceType
XML Representation:
<Metadata xmlns="http://www.vmware.com/vcloud/v1.5" href="xs:anyURI" type="xs:string">
    <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
            rel="xs:string" model="xs:string"/>
    <MetadataEntry href="xs:anyURI" type="xs:string">
        <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                rel="xs:string" model="xs:string"/>
        <Domain visibility="xs:string"/>
        <Key> xs:string </Key>
        <TypedValue/>
    </MetadataEntry>
</Metadata>

Attributes

Attribute Type Required Modifiable Since Deprecated Description
href anyURI No always 1.5 The URI of the entity.
type string No always 1.5 The MIME type of the entity.

Elements

Element Type Required Modifiable Since Deprecated Description
Link LinkType No none 1.5 A reference to an entity or operation associated with this object.
MetadataEntry MetadataEntryType No always 1.5 A single metadata entry, including access domain and visibility controls.
VCloudExtension VCloudExtensionType No always 1.5 An optional extension element that can contain an arbitrary number of elements and attributes. Not related to extension services.

Operations

CRUD Operation Description Since Deprecated
read GET /admin/catalog/{id}/metadata Retrieve metadata associated with the catalog. 1.5
read GET /admin/edgeGateway/{id}/metadata Retrieve metadata associated with the gateway. 35.0
read GET /admin/network/{id}/metadata Retrieve metadata associated with the network. 1.5
read GET /admin/org/{id}/metadata Retrieve metadata associated with the organization. 1.5
read GET /admin/providervdc/{id}/metadata Retrieve metadata associated with the provider vDC. 1.5
read GET /admin/pvdcStorageProfile/{id}/metadata Retrieve metadata associated with the Provider VDC Storage Profile. 5.1
read GET /admin/vdc/{id}/metadata Retrieve metadata associated with the virtual datacenter. 1.5
read GET /admin/vdcStorageProfile/{id}/metadata Retrieve metadata associated with the vDC storage profile.
read GET /catalog/{id}/metadata Retrieve all catalog metadata. 1.5
read GET /catalogItem/{id}/metadata Retrieve all metadata associated with a catalog item. 1.5
read GET /disk/{id}/metadata Retrieve metadata associated with the disk. 5.1
read GET /media/{id}/metadata Retrieve metadata associated with a media object. 1.5
read GET /network/{id}/metadata Retrieve metadata associated with the network. 1.5
read GET /org/{id}/metadata Retrieve metadata associated with the organization. 1.5
read GET /vApp/{id}/metadata Retrieve metadata associated with the vApp or VM. 1.5
read GET /vAppTemplate/{id}/metadata Retrieve metadata associated with the vApp template or VM. 1.5
read GET /vdc/{id}/metadata Retrieve metadata associated with a vDC. 1.5
read GET /vdcStorageProfile/{id}/metadata Retrieve metadata associated with the vDC storage profile.
as input POST /admin/catalog/{id}/metadata Merge the metadata provided in the request with existing metadata. 1.5
as input POST /admin/edgeGateway/{id}/metadata Sets all the metadata for the specified gateway. 35.0
as input POST /admin/network/{id}/metadata Merge the metadata provided in the request with existing metadata. 1.5
as input POST /admin/org/{id}/metadata Merge the metadata provided in the request with existing metadata. 1.5
as input POST /admin/providervdc/{id}/metadata Merge the metadata provided in the request with existing metadata. 1.5
as input POST /admin/pvdcStorageProfile/{id}/metadata Merge the metadata provided in the request with existing metadata.
as input POST /admin/vdc/{id}/metadata Merge the metadata provided in the request with existing metadata. 1.5
as input POST /admin/vdcStorageProfile/{id}/metadata Merge the metadata provided in the request with existing metadata.
as input POST /catalogItem/{id}/metadata Merge the metadata provided in the request with existing catalog item metadata. 1.5
as input POST /disk/{id}/metadata Merge the metadata provided in the request with existing metadata. 5.1
as input POST /media/{id}/metadata Merge the metadata provided in the request with existing metadata. 1.5
as input POST /vApp/{id}/metadata Merge the metadata provided in the request with existing metadata. 1.5
as input POST /vAppTemplate/{id}/metadata Merge the metadata provided in the request with existing metadata. 1.5