VMware VCLOUD API 1.0 - API User Manual

vCloud API Programming Guide
36 VMware, Inc.
Thisresponsebodyincludes:
 ALinkelementthatreferencestheorganizationthatcontainsthiscatalog:
<Link rel="up" type="application/vnd.vmware.vcloud.org+xml"
href="http://vcloud.example.com/api/v1.0/org/5"/>

ALinkelementthatyoucanusetoaddanitemtothecatalog:
<Link rel="add" type="application/vnd.vmware.vcloud.catalogItem+xml"
href="http://vcloud.example.com/api/v1.0/catalog/32/catalogItems"/>

SeveralCatalogItemelements.EachoftheseelementsincludesanhrefattributewhosevalueisaURL
thatyoucanGETtoobtainmoreinformationabouttheitem,asshowninExample 3‐3.
 AnIsPublishedelementwhosevalueindicateswhetherthiscatalogisvisibletootherorganizations.
Formoreinformationaboutcreatingcatalogsandmanagingtheircontents,see“CatalogingvAppTemplates
andMediaImages”onpage 54and“CatalogAdministration”onpage 107.Formoreinformationaboutthe
Catalogelementschema,see“Catalog”onpage 160.
Get Information About a CatalogItem
ACatalogItemelementcanreferenceavApptemplateoramediaobject.Requeststogetmoreinformation
aboutaCatalogItemreturnaCatalogItemdocumentthatincludes:
 TheURLofthereferencedobject
 LinkelementsthatenableanauthorizedusertomodifyorremovetheCatalogItem
 AnEntityelementthatincludesthehref,type,andnameoftheobjectthattheCatalogItemreferences.
AnEntitycanappearinatmostoneCatalog.
 OptionalPropertyelements,eachofwhichisakey=valuepair.AnorganizationcanuseProperty
elementstoimplementakey‐basedlookupschemeforcatalogitems.
Example 3-3. Get Information About a CatalogItem
Request:
GET http://vcloud.example.com/api/v1.0/catalogItem/221
Response:
200 OK
Content-Type: application/vnd.vmware.vcloud.catalogItem+xml
...
<CatalogItem name="Ubuntu Template with vsftpd"
href="http://vcloud.example.com/api/v1.0/catalogItem/221" ...>
<Link rel="edit" type="application/vnd.vmware.vcloud.catalogItem+xml"
href="http://vcloud.example.com/api/v1.0/catalogItem/221"/>
<Link rel="remove" href="http://vcloud.example.com/api/v1.0/catalogItem/221"/>
<Description>Ubuntu Template with vsftpd</Description>
<Entity href="http://vcloud.example.com/api/v1.0/vAppTemplate/vappTemplate-111"
type="application/vnd.vmware.vcloud.vAppTemplate+xml" name="Ubuntu Template
with vsftpd"/>
<Property key="Company">Example</Property>
</CatalogItem>

VMware VCLOUD API 1.0 - API Specifications

General

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