VMware VCLOUD API 1.0 - API User Manual

VMware, Inc. 35
Chapter 3 Browsing
<Link rel="down" type="application/vnd.vmware.vcloud.network+xml"
href="http://vcloud.example.com/api/v1.0/network/14" name="IsolatedOrgNet"/>
<Link rel="down" type="application/vnd.vmware.vcloud.network+xml"
href="http://vcloud.example.com/api/v1.0/network/54" name="Internet"/>
<Description>Example Corp’s Primary Organization</Description>
</Org>
Thisresponseshowsthattheorganizationcontainstheseobjects,eachofwhichisreferencedbyaLinkwhose
relattributehasavalueofdown(indicatingthatthelinkreferencesanobjectcontainedbytheorganization):
 AcatalognamedMainCatalog,whoseURLishttp://vcloud.example.com/api/v1.0/catalog/32
 AcatalognamedSharedCatalog,whoseURLishttp://vcloud.example.com/api/v1.0/catalog/37
 Alinktotheorganization’sTasksList
 AvDCnamedExampleVdc01whoseURLishttp://vcloud.example.com/api/v1.0/vdc/5
 Twonetworks:onenamedIsolatedOrgNetwhoseURLis
http://vcloud.example.com/api/v1.0/network/14,andonenamedInternetwhoseURLis
http://vcloud.example.com/api/v1.0/network/54
 Actionlinksthatenableanadministratortocontrolaccesstothecatalogs
List the Contents of a Catalog
Aclientcanusethehrefvaluefromanyoftherel="down"linksinanOrgbodytogetmoreinformation
abouttheobjecttowhichthelinkrefers,asshowninExample 3‐2,whichrequestsmoreinformationaboutone
ofthecatalogsintheorganization.
Example 3-2. List the Contents of a Catalog
Request:
GET http://vcloud.example.com/api/v1.0/catalog/32
Response:
200 OK
Content-Type: application/vnd.vmware.vcloud.catalog+xml
...
<Catalog name="MainCatalog" type="application/vnd.vmware.vcloud.catalog+xml"
href="http://vcloud.example.com/api/v1.0/catalog/32" ...>
<Link rel="up" type="application/vnd.vmware.vcloud.org+xml"
href="http://vcloud.example.com/api/v1.0/org/5"/>
<Link rel="add" type="application/vnd.vmware.vcloud.catalogItem+xml"
href="http://vcloud.example.com/api/v1.0/catalog/32/catalogItems"/>
<Description>Main Org Catalog</Description>
<CatalogItems>
<CatalogItem type="application/vnd.vmware.vcloud.catalogItem+xml" name="Ubuntu Template
with vsftpd" href="http://vcloud.example.com/api/v1.0/catalogItem/221"/>
<CatalogItem type="application/vnd.vmware.vcloud.catalogItem+xml" name="Ubuntu Boot
Floppy" href="http://vcloud.example.com/api/v1.0/catalogItem/222"/>
<CatalogItem type="application/vnd.vmware.vcloud.catalogItem+xml" name="Ubuntu ISO Image"
href="http://vcloud.example.com/api/v1.0/catalogItem/223"/>
...
</CatalogItems>
<IsPublished>true</IsPublished>
</Catalog>

VMware VCLOUD API 1.0 - API Specifications

General

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