VMware Cloud Director API - PUT-Catalog

PUT /admin/catalog/{id}

Operation:

PUT /admin/catalog/{id}

Description:

Update the name, description and storage profiles of a catalog.

Since:

0.9

Input parameters

Consume media type(s):: application/vnd.vmware.admin.catalog+xml
application/vnd.vmware.admin.catalog+json
Input type:: AdminCatalogType

Output parameters

UserType

Produce media type(s):: application/vnd.vmware.admin.catalog+xml
application/vnd.vmware.admin.catalog+json
Output type:: AdminCatalogType

Examples

Request: HTTP 1.1
PUT /api/admin/catalog/2a8c1427-7ba9-4a5a-ba08-040b630d9859

Headers:
Content-Length: 3564
Content-Type: application/vnd.vmware.admin.catalog+xml; charset=ISO-8859-1
x-vcloud-authorization: FQMWZgFq5mhMRSpt2ecxnsAXTxRpxdbZ/z2u6uwEH+w=

Body:

<?xml version="1.0" encoding="UTF-8"?><vcloud:AdminCatalog
    xmlns:vcloud="http://www.vmware.com/vcloud/v1.5"
    href="https://vcloud.example.com/api/admin/catalog/2a8c1427-7ba9-4a5a-ba08-040b630d9859"
    id="urn:vcloud:catalog:2a8c1427-7ba9-4a5a-ba08-040b630d9859"
    name="New Catalog"
    type="application/vnd.vmware.admin.catalog+xml">
    <vcloud:Link
        href="https://vcloud.example.com/api/admin/org/7cc8d565-1203-49bd-b50c-24e0acbaeb5a"
        rel="up"
        type="application/vnd.vmware.admin.organization+xml"/>
    <vcloud:Link
        href="https://vcloud.example.com/api/catalog/2a8c1427-7ba9-4a5a-ba08-040b630d9859"
        rel="alternate"
        type="application/vnd.vmware.vcloud.catalog+xml"/>
    <vcloud:Link
        href="https://vcloud.example.com/api/admin/catalog/2a8c1427-7ba9-4a5a-ba08-040b630d9859/owner"
        rel="down"
        type="application/vnd.vmware.vcloud.owner+xml"/>
    <vcloud:Link
        href="https://vcloud.example.com/api/admin/catalog/2a8c1427-7ba9-4a5a-ba08-040b630d9859/metadata"
        rel="down"
        type="application/vnd.vmware.vcloud.metadata+xml"/>
    <vcloud:Link
        href="https://vcloud.example.com/api/catalog/2a8c1427-7ba9-4a5a-ba08-040b630d9859/catalogItems"
        rel="add"
        type="application/vnd.vmware.vcloud.catalogItem+xml"/>
    <vcloud:Link
        href="https://vcloud.example.com/api/catalog/2a8c1427-7ba9-4a5a-ba08-040b630d9859/action/upload"
        rel="add"
        type="application/vnd.vmware.vcloud.media+xml"/>
    <vcloud:Link
        href="https://vcloud.example.com/api/catalog/2a8c1427-7ba9-4a5a-ba08-040b630d9859/action/upload"
        rel="add"
        type="application/vnd.vmware.vcloud.uploadVAppTemplateParams+xml"/>
    <vcloud:Link
        href="https://vcloud.example.com/api/admin/catalog/2a8c1427-7ba9-4a5a-ba08-040b630d9859"
        rel="edit"
        type="application/vnd.vmware.admin.catalog+xml"/>
    <vcloud:Link
        href="https://vcloud.example.com/api/catalog/2a8c1427-7ba9-4a5a-ba08-040b630d9859/action/copy"
        rel="copy"
        type="application/vnd.vmware.vcloud.copyOrMoveCatalogItemParams+xml"/>
    <vcloud:Link
        href="https://vcloud.example.com/api/catalog/2a8c1427-7ba9-4a5a-ba08-040b630d9859/action/move"
        rel="move"
        type="application/vnd.vmware.vcloud.copyOrMoveCatalogItemParams+xml"/>
    <vcloud:Link
        href="https://vcloud.example.com/api/catalog/2a8c1427-7ba9-4a5a-ba08-040b630d9859/action/captureVApp"
        rel="add"
        type="application/vnd.vmware.vcloud.captureVAppParams+xml"/>
    <vcloud:Link
        href="https://vcloud.example.com/api/admin/catalog/2a8c1427-7ba9-4a5a-ba08-040b630d9859/action/publish"
        rel="publish"
        type="application/vnd.vmware.admin.publishCatalogParams+xml"/>
    <vcloud:Link
        href="https://vcloud.example.com/api/admin/catalog/2a8c1427-7ba9-4a5a-ba08-040b630d9859/action/publishToExternalOrganizations"
        rel="publishToExternalOrganizations"
        type="application/vnd.vmware.admin.publishExternalLibraryParams+xml"/>
    <vcloud:Link
        href="https://vcloud.example.com/api/admin/catalog/2a8c1427-7ba9-4a5a-ba08-040b630d9859/action/subscribeToExternalLibrary"
        rel="subscribeToExternalLibrary"
        type="application/vnd.vmware.admin.externalLibrarySubscriptionParams+xml"/>
    <vcloud:Description>Catalog Description</vcloud:Description>
    <vcloud:Owner
        type="application/vnd.vmware.vcloud.owner+xml">
        <vcloud:User
            href="https://vcloud.example.com/api/admin/user/6243d11d-2fad-4988-934c-4ada2bc3808b"
            name="system"
            type="application/vnd.vmware.admin.user+xml"/>
    </vcloud:Owner>
    <vcloud:CatalogItems/>
    <vcloud:IsPublished>false</vcloud:IsPublished>
    <vcloud:DateCreated>2013-02-13T18:35:02.247+02:00</vcloud:DateCreated>
    <vcloud:VersionNumber>1</vcloud:VersionNumber>
    <vcloud:CatalogStorageProfiles/>
</vcloud:AdminCatalog>
Response: HTTP/1.1 200 OK

Headers:
Content-Length: 3623
Content-Type: application/vnd.vmware.admin.catalog+xml;version=5.5
Vary: Accept-Encoding

Body:

<?xml version="1.0" encoding="UTF-8"?><AdminCatalog
    xmlns="http://www.vmware.com/vcloud/v1.5"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    href="https://vcloud.example.com/api/admin/catalog/2a8c1427-7ba9-4a5a-ba08-040b630d9859"
    id="urn:vcloud:catalog:2a8c1427-7ba9-4a5a-ba08-040b630d9859"
    name="New Catalog"
    type="application/vnd.vmware.admin.catalog+xml"
    xsi:schemaLocation="http://www.vmware.com/vcloud/v1.5 http://https://vcloud.example.com/api/v1.5/schema/master.xsd">
    <Link
        href="https://vcloud.example.com/api/admin/org/7cc8d565-1203-49bd-b50c-24e0acbaeb5a"
        rel="up"
        type="application/vnd.vmware.admin.organization+xml"/>
    <Link
        href="https://vcloud.example.com/api/catalog/2a8c1427-7ba9-4a5a-ba08-040b630d9859"
        rel="alternate"
        type="application/vnd.vmware.vcloud.catalog+xml"/>
    <Link
        href="https://vcloud.example.com/api/admin/catalog/2a8c1427-7ba9-4a5a-ba08-040b630d9859/owner"
        rel="down"
        type="application/vnd.vmware.vcloud.owner+xml"/>
    <Link
        href="https://vcloud.example.com/api/admin/catalog/2a8c1427-7ba9-4a5a-ba08-040b630d9859/metadata"
        rel="down"
        type="application/vnd.vmware.vcloud.metadata+xml"/>
    <Link
        href="https://vcloud.example.com/api/catalog/2a8c1427-7ba9-4a5a-ba08-040b630d9859/catalogItems"
        rel="add"
        type="application/vnd.vmware.vcloud.catalogItem+xml"/>
    <Link
        href="https://vcloud.example.com/api/catalog/2a8c1427-7ba9-4a5a-ba08-040b630d9859/action/upload"
        rel="add"
        type="application/vnd.vmware.vcloud.media+xml"/>
    <Link
        href="https://vcloud.example.com/api/catalog/2a8c1427-7ba9-4a5a-ba08-040b630d9859/action/upload"
        rel="add"
        type="application/vnd.vmware.vcloud.uploadVAppTemplateParams+xml"/>
    <Link
        href="https://vcloud.example.com/api/admin/catalog/2a8c1427-7ba9-4a5a-ba08-040b630d9859"
        rel="edit"
        type="application/vnd.vmware.admin.catalog+xml"/>
    <Link
        href="https://vcloud.example.com/api/admin/catalog/2a8c1427-7ba9-4a5a-ba08-040b630d9859"
        rel="remove"/>
    <Link
        href="https://vcloud.example.com/api/catalog/2a8c1427-7ba9-4a5a-ba08-040b630d9859/action/copy"
        rel="copy"
        type="application/vnd.vmware.vcloud.copyOrMoveCatalogItemParams+xml"/>
    <Link
        href="https://vcloud.example.com/api/catalog/2a8c1427-7ba9-4a5a-ba08-040b630d9859/action/move"
        rel="move"
        type="application/vnd.vmware.vcloud.copyOrMoveCatalogItemParams+xml"/>
    <Link
        href="https://vcloud.example.com/api/catalog/2a8c1427-7ba9-4a5a-ba08-040b630d9859/action/captureVApp"
        rel="add"
        type="application/vnd.vmware.vcloud.captureVAppParams+xml"/>
    <Link
        href="https://vcloud.example.com/api/admin/catalog/2a8c1427-7ba9-4a5a-ba08-040b630d9859/action/publish"
        rel="publish"
        type="application/vnd.vmware.admin.publishCatalogParams+xml"/>
    <Link
        href="https://vcloud.example.com/api/admin/catalog/2a8c1427-7ba9-4a5a-ba08-040b630d9859/action/publishToExternalOrganizations"
        rel="publishToExternalOrganizations"
        type="application/vnd.vmware.admin.publishExternalLibraryParams+xml"/>
    <Link
        href="https://vcloud.example.com/api/admin/catalog/2a8c1427-7ba9-4a5a-ba08-040b630d9859/action/subscribeToExternalLibrary"
        rel="subscribeToExternalLibrary"
        type="application/vnd.vmware.admin.externalLibrarySubscriptionParams+xml"/>
    <Description>Catalog Description</Description>
    <Owner
        type="application/vnd.vmware.vcloud.owner+xml">
        <User
            href="https://vcloud.example.com/api/admin/user/6243d11d-2fad-4988-934c-4ada2bc3808b"
            name="system"
            type="application/vnd.vmware.admin.user+xml"/>
    </Owner>
    <CatalogItems/>
    <IsPublished>false</IsPublished>
    <DateCreated>2013-02-13T18:35:02.247+02:00</DateCreated>
    <VersionNumber>2</VersionNumber>
    <CatalogStorageProfiles/>
</AdminCatalog>