VMware Cloud Director API - MetadataValue

VMware Cloud Director API - MetadataValue

MetadataValueType

Element:
MetadataValue
Type:
MetadataValueType
Namespace:
http://www.vmware.com/vcloud/v1.5
Description:
Since:
Schema:
common.xsd
Media type(s):
application/vnd.vmware.vcloud.metadata.value+json
application/vnd.vmware.vcloud.metadata.value+xml
Extends:
ResourceType
XML Representation:
<MetadataValue 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"/>
    <Domain visibility="xs:string"/>
    <TypedValue/>
</MetadataValue>

Attributes

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

Elements

Element Type Required Modifiable Since Deprecated Description
Domain MetadataDomainTagType No 5.1 One of:
GENERAL
SYSTEM
Link LinkType No none A reference to an entity or operation associated with this object.
TypedValue MetadataTypedValue Yes 5.1
VCloudExtension VCloudExtensionType No always 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/{domain}/{key} Retrieve the value of the specified key in the specified domain from catalog metadata. 5.1
read GET /admin/catalog/{id}/metadata/{key} Retrieve the value of the specified key from catalog metadata. 1.5
read GET /admin/edgeGateway/{id}/metadata/{domain}/{key} Retrieve the value of the specified key in the specified domain from gateway metadata. 35.0
read GET /admin/edgeGateway/{id}/metadata/{key} Retrieve the value of the specified key from gateway metadata. 35.0
read GET /admin/network/{id}/metadata/{domain}/{key} Retrieve the value of the specified key in the specified domain from network metadata. 5.1
read GET /admin/network/{id}/metadata/{key} Retrieve the value of the specified key from network metadata. 1.5
read GET /admin/org/{id}/metadata/{domain}/{key} Retrieve the value of the specified key in the specified domain from organization metadata . 5.1
read GET /admin/org/{id}/metadata/{key} Retrieve the value of the specified key from organization metadata. 1.5
read GET /admin/providervdc/{id}/metadata/{domain}/{key} Retrieve the value of the specified key in the specified domain from provider vDC metadata. 5.1
read GET /admin/providervdc/{id}/metadata/{key} Retrieve the value of the specified key from provider vDC metadata. 1.5
read GET /admin/pvdcStorageProfile/{id}/metadata/{domain}/{key} Retrieve the value of the specified key from Provider VDC Storage Profile metadata. 5.1
read GET /admin/pvdcStorageProfile/{id}/metadata/{key} Retrieve the value of the specified key from Provider VDC Storage Profile metadata.
read GET /admin/vdc/{id}/metadata/{domain}/{key} Retrieve the value of the specified key in the specified domain from virtual datacenter metadata. 5.1
read GET /admin/vdc/{id}/metadata/{key} Retrieve the value of the specified key from virtual datacenter metadata. 1.5
read GET /admin/vdcStorageProfile/{id}/metadata/{domain}/{key} Retrieve the value of the specified key from vDC storage profile metadata.
read GET /admin/vdcStorageProfile/{id}/metadata/{key} Retrieve the value of the specified key from vDC storage profile metadata.
read GET /catalog/{id}/metadata/{domain}/{key} Retrieve the value of the specified key in the specified domain from catalog metadata. 5.1
read GET /catalog/{id}/metadata/{key} Retrieve the value of the specified key from catalog metadata. 1.5
read GET /catalogItem/{id}/metadata/{domain}/{key} Retrieve the value of the specified key in the specified domain from catalog item metadata. 5.1
read GET /catalogItem/{id}/metadata/{key} Retrieve the value of the specified key from catalog item metadata. 1.5
read GET /disk/{id}/metadata/{domain}/{key} Retrieve the value of the specified key from disk metadata. 5.1
read GET /disk/{id}/metadata/{key} Retrieve the value of the specified key from disk metadata. 5.1
read GET /media/{id}/metadata/{domain}/{key} Retrieve the value of the specified key in the specified domain from media object metadata. 5.1
read GET /media/{id}/metadata/{key} Retrieve the value of the specified key from media object metadata. 1.5
read GET /network/{id}/metadata/{domain}/{key} Retrieve the value of the specified key in the specified domain from network metadata. 5.1
read GET /network/{id}/metadata/{key} Retrieve the value of the specified key from network metadata. 1.5
read GET /org/{id}/metadata/{domain}/{key} Retrieve the value of the specified key in the specified domain from organization metadata. 5.1
read GET /org/{id}/metadata/{key} Retrieve the value of the specified key from organization metadata. 1.5
read GET /vApp/{id}/metadata/{domain}/{key} Retrieve the value of the specified key from vApp or VM metadata. 5.1
read GET /vApp/{id}/metadata/{key} Retrieve the value of the specified key from vApp or VM metadata. 1.5
read GET /vAppTemplate/{id}/metadata/{domain}/{key} Retrieve the value of the specified key in the specified domain from vApp template or VM metadata. 5.1
read GET /vAppTemplate/{id}/metadata/{key} Retrieve the value of the specified key from vApp template or VM metadata. 1.5
read GET /vdc/{id}/metadata/{domain}/{key} Retrieve the value of the specified key in the specified domain from vDC metadata. 5.1
read GET /vdc/{id}/metadata/{key} Retrieve the value of the specified key from vDC metadata. 1.5
read GET /vdcStorageProfile/{id}/metadata/{domain}/{key} Retrieve the value of the specified key from vDC storage profile metadata.
read GET /vdcStorageProfile/{id}/metadata/{key} Retrieve the value of the specified key from vDC storage profile metadata.
update PUT /admin/catalog/{id}/metadata/{domain}/{key} Set the value for the specified metadata key in the specified domain to the value provided, overwriting any existing value. 5.1
update PUT /admin/catalog/{id}/metadata/{key} Set the value for the specified metadata key to the value provided, overwriting any existing value. 1.5
update PUT /admin/edgeGateway/{id}/metadata/{domain}/{key} Set the value for the specified metadata key in the specified domain to the value provided, overwriting any existing value. 35.0
update PUT /admin/edgeGateway/{id}/metadata/{key} Set the value for the specified metadata key to the value provided, overwriting any existing value. 35.0
update PUT /admin/network/{id}/metadata/{domain}/{key} Set the value for the specified metadata key in the specified domain to the value provided, overwriting any existing value. 5.1
update PUT /admin/network/{id}/metadata/{key} Set the value for the specified metadata key to the value provided, overwriting any existing value. 1.5
update PUT /admin/org/{id}/metadata/{domain}/{key} Set the value for the specified metadata key in the specified domain to the value provided, overwriting any existing value. 5.1
update PUT /admin/org/{id}/metadata/{key} Set the value for the specified metadata key to the value provided, overwriting any existing value. 1.5
update PUT /admin/providervdc/{id}/metadata/{domain}/{key} Set the value for the specified metadata key in the specified domain to the value provided, overwriting any existing value. 5.1
update PUT /admin/providervdc/{id}/metadata/{key} Set the value for the specified metadata key to the value provided, overwriting any existing value. 1.5
update PUT /admin/pvdcStorageProfile/{id}/metadata/{domain}/{key} Set the value for the specified metadata key to the value provided, overwriting any existing value.
update PUT /admin/pvdcStorageProfile/{id}/metadata/{key} Set the value for the specified metadata key to the value provided, overwriting any existing value.
update PUT /admin/vdc/{id}/metadata/{domain}/{key} Set the value for the specified metadata key in the specified domain to the value provided, overwriting any existing value. 5.1
update PUT /admin/vdc/{id}/metadata/{key} Set the value for the specified metadata key to the value provided, overwriting any existing value. 1.5
update PUT /admin/vdcStorageProfile/{id}/metadata/{domain}/{key} Set the value for the specified metadata key to the value provided, overwriting any existing value.
update PUT /admin/vdcStorageProfile/{id}/metadata/{key} Set the value for the specified metadata key to the value provided, overwriting any existing value.
update PUT /catalogItem/{id}/metadata/{domain}/{key} Set the metadata value for the specified key in the specified domain to the value provided, overwriting any existing value. 5.1
update PUT /catalogItem/{id}/metadata/{key} Set the metadata value for the specified key to the value provided, overwriting any existing value. 1.5
update PUT /disk/{id}/metadata/{domain}/{key} Set the value for the specified metadata key to the value provided, overwriting any existing value. 5.1
update PUT /disk/{id}/metadata/{key} Set the value for the specified metadata key to the value provided, overwriting any existing value. 5.1
update PUT /media/{id}/metadata/{domain}/{key} Set the value for the specified metadata key in the specified domain to the value provided, overwriting any existing value. 5.1
update PUT /media/{id}/metadata/{key} Set the value for the specified metadata key to the value provided, overwriting any existing value. 1.5
update PUT /vApp/{id}/metadata/{domain}/{key} Set the value for the specified metadata key to the value provided, overwriting any existing value. 5.1
update PUT /vApp/{id}/metadata/{key} Set the value for the specified metadata key to the value provided, overwriting any existing value. 1.5
update PUT /vAppTemplate/{id}/metadata/{domain}/{key} Set the value for the specified metadata key in the specified domain to the value provided, overwriting any existing value. 5.1
update PUT /vAppTemplate/{id}/metadata/{key} Set the value for the specified metadata key to the value provided, overwriting any existing value. 1.5
delete DELETE /admin/catalog/{id}/metadata/{domain}/{key} Delete the specified key in the specified domain and its value from catalog metadata. 5.1
delete DELETE /admin/catalog/{id}/metadata/{key} Delete the specified key and its value from catalog metadata. 1.5
delete DELETE /admin/edgeGateway/{id}/metadata/{domain}/{key} Delete the specified key in the specified domain and its value from gateway metadata. 35.0
delete DELETE /admin/edgeGateway/{id}/metadata/{key} Delete the specified key and its value from gateway metadata. 35.0
delete DELETE /admin/network/{id}/metadata/{domain}/{key} Delete the specified key in the specified domain and its value from network metadata. 5.1
delete DELETE /admin/network/{id}/metadata/{key} Delete the specified key and its value from network metadata. 1.5
delete DELETE /admin/org/{id}/metadata/{domain}/{key} Delete the specified key in the specified domain and its value from organization metadata. 5.1
delete DELETE /admin/org/{id}/metadata/{key} Delete the specified key and its value from organization metadata. 1.5
delete DELETE /admin/providervdc/{id}/metadata/{domain}/{key} Delete the specified key in the specified domain and its value from provider vDC metadata. 5.1
delete DELETE /admin/providervdc/{id}/metadata/{key} Delete the specified key and its value from provider vDC metadata. 1.5
delete DELETE /admin/pvdcStorageProfile/{id}/metadata/{domain}/{key} Delete the specified key and its value from Provider VDC Storage Profile metadata.
delete DELETE /admin/pvdcStorageProfile/{id}/metadata/{key} Delete the specified key and its value from Provider VDC Storage Profile metadata.
delete DELETE /admin/vdc/{id}/metadata/{domain}/{key} Delete the specified key in the specified domain and its value from virtual datacenter metadata. 5.1
delete DELETE /admin/vdc/{id}/metadata/{key} Delete the specified key and its value from virtual datacenter metadata. 1.5
delete DELETE /admin/vdcStorageProfile/{id}/metadata/{domain}/{key} Delete the specified key and its value from vDC storage profile metadata.
delete DELETE /admin/vdcStorageProfile/{id}/metadata/{key} Delete the specified key and its value from vDC storage profile metadata.
delete DELETE /catalogItem/{id}/metadata/{domain}/{key} Delete the specified key in the specified domain and its value from catalog item metadata. 5.1
delete DELETE /catalogItem/{id}/metadata/{key} Delete the specified key and its value from catalog item metadata. 1.5
delete DELETE /disk/{id}/metadata/{domain}/{key} Delete the specified key and its value from disk metadata. 5.1
delete DELETE /disk/{id}/metadata/{key} Delete the specified key and its value from disk metadata. 5.1
delete DELETE /media/{id}/metadata/{domain}/{key} Delete the specified key in the specified domain and its value from media object metadata. 5.1
delete DELETE /media/{id}/metadata/{key} Delete the specified key and its value from media object metadata. 1.5
delete DELETE /vApp/{id}/metadata/{domain}/{key} Delete the specified key and its value from vApp or VM metadata. 5.1
delete DELETE /vApp/{id}/metadata/{key} Delete the specified key and its value from vApp or VM metadata. 1.5
delete DELETE /vAppTemplate/{id}/metadata/{domain}/{key} Delete the specified key in the specified domain and its value from vApp template or VM metadata. 5.1
delete DELETE /vAppTemplate/{id}/metadata/{key} Delete the specified key and its value from vApp template or VM metadata. 1.5