VMware VCLOUD API 1.0 - API User Manual

VMware, Inc. 109
Chapter 6 Administrative Operations
<Description>Custom Catalog</Description>
<CatalogItems>
...
</CatalogItems>
...
</Catalog>
Publish a Catalog
PublishingacatalogmakesthecatalogvisibletoallorganizationsinavCloud.Anadministratorofan
organizationthatcanpublishcatalogs(onewhoseCanPublishCatalogselementhasavalueoftrue)can
publishacatalogbymakingaPOSTrequesttothecatalog’spublishURLandsupplyinga
PublishCatalogParamsbody
thatsetsthevalueofthecatalog’sIsPublishedelementtotrue.Example 6‐21
publishesthecatalogcreatedinExample 6‐19.
Example 6-21. Publish a Catalog
Request:
POST http://vcloud.example.com/api/v1.0/admin/catalog/32/action/publish
Content-Type: application/vnd.vmware.admin.publishCatalogParams+xml
...
<PublishCatalogParams xmlns="http://www.vmware.com/vcloud/v1">
<IsPublished>true</IsPublished>
</PublishCatalogParams>
Response:
204 No Content
Modify Catalog Metadata
Anadministratorcanmodifycatalogmetadatasuchasitsnameanddescriptionbycreatingamodified
CatalogbodyandPUTtingittothecatalog’seditlink.TherequestinExample 6‐22changesthenameand
descriptionofthecatalogcreatedinExample 6‐19.TheresponsecontainsthemodifiedCatalogbody,
includingtheCatalogItemselement,whichwasunchangedby,andnotincludedin,therequest.
Example 6-22. Modify Catalog Metadata
Request:
PUT http://vcloud.example.com/api/v1.0/admin/catalog/32
Content-Type: application/vnd.vmware.admin.catalog+xml
<Catalog name="TechOps Catalog 01" xmlns="http://www.vmware.com/vcloud/v1">
<Description>TechOps Approved Templates Catalog</Description>
</Catalog>
Response:
200 OK
Content-Type: application/vnd.vmware.admin.catalog+xml
<Catalog href="http://vcloud.example.com/api/v1.0/catalog/32" name="TechOps Catalog 01" ...>
<Description>TechOps Approved Templates Catalog</Description>
<Link rel="add" type="application/vnd.vmware.vcloud.catalogItem+xml"
href="http://vcloud.example.com/api/v1.0/catalog/32/catalogItems"/>

VMware VCLOUD API 1.0 - API Specifications

General

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