VMware VCLOUD API 1.0 - API User Manual

vCloud API Programming Guide
56 VMware, Inc.
Remove an Item from a Catalog
AorganizationadministratororauserwithadequatepermissionscanremoveaCatalogItembymakinga
DELETErequesttotheitsrel="remove"link.Example 4‐23removestheCatalogItemcreatedin
Example 4‐22.
Example 4-23. Remove a CatalogItem
Request:
DELETE http://vcloud.example.com/api/v1.0/catalogItem/221
Response:
204 No Content
Catalog Links in a VApp Template or Media Image
EveryvAppTemplateandMediaelementthathasbeenaddedtoacatalogcontainsarel="catalogItem"
linkwhosehrefvalueistheURLoftheCatalogItemthatreferencesthetemplateormediaimage(seethe
responseinExample 3‐6onpage 39).AclientcanGETthatURLandexaminetheresponse
tofindthe
rel="up"linkintheCatalogItem(seetheresponseinExample 4‐22).Thislinkisareferencetothecatalog
thatcontainstheCatalogItem.
Controlling Access
AnorganizationadministratorcanusecontrolAccesslinkstocontrolaccesstocatalogsandvApps.
Control Access to Catalogs
Whenyoulistthecontentsofanorganization,eachcatalogincludesaccesscontrollinks,asshownin
Example 4‐24,whichisanexcerptfromExample 3‐1onpage 34.
Example 4-24. Access Control Links for a Catalog
<Org ... >
<Link rel="down" type="application/vnd.vmware.vcloud.catalog+xml"
href="http://vcloud.example.com/api/v1.0/catalog/32" name="MainCatalog"/>
<Link rel="down" type="application/vnd.vmware.vcloud.controlAccess+xml"
href="http://vcloud.example.com/api/v1.0/catalog/32/controlAccess/"/>
<Link rel="controlAccess" type="application/vnd.vmware.vcloud.controlAccess+xml"
href="http://vcloud.example.com/api/v1.0/catalog/32/action/controlAccess/"/>
<Link rel="down" type="application/vnd.vmware.vcloud.catalog+xml"
href="http://vcloud.example.com/api/v1.0/catalog/37" name="Shared Catalog"/>
<Link rel="down" type="application/vnd.vmware.vcloud.controlAccess+xml"
href="http://vcloud.example.com/api/v1.0/catalog/37/controlAccess/"/>
<Link rel="controlAccess" type="application/vnd.vmware.vcloud.controlAccess+xml"
href="http://vcloud.example.com/api/v1.0/catalog/37/action/controlAccess/"/>
...
</Org>
Foreachofthecatalogslistedinthisexcerpt,threelinksareprovided:
 ALinkwithrel="down"thatprovidestheURLforthecatalogitself
 AnotherLinkwithrel="down"thataclientcanusetoretrievethecatalog’saccesscontrolsettings
 ALinkwithrel="controlAccess"thataclientcanusetomodifythecatalog’saccesscontrolsetting
Anorganizationadministratororprivilegedusercanusetheselinkstoviewormodifyaccesscontrolsona
catalog.Example 4‐25showstherequesttoviewtheaccesscontrolsettingsforacatalog.

VMware VCLOUD API 1.0 - API Specifications

General

Brand	VMware
Model	VCLOUD API 1.0 - API
Category	Software
Language	English