AdminCatalog

Element:
AdminCatalog
Type:
AdminCatalogType
Namespace:
http://www.vmware.com/vcloud/v1.5
Description:
Admin representation of the container for meta data (key-value pair) associated to different entities in the system.
Since:
1.5
Schema:
vCloudEntities.xsd
Media type(s):
application/vnd.vmware.admin.catalog+xml
Extends:
CatalogType
XML Representation:
<AdminCatalog xmlns="http://www.vmware.com/vcloud/v1.5" href="xs:anyURI" type="xs:string" name="xs:string" id="xs:string">
    <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
            rel="xs:string"/>
    <Description> xs:string </Description>
    <Tasks>
        <Task href="xs:anyURI" type="xs:string" name="xs:string" id="xs:string"
                status="xs:string" operation="xs:string" operationName="xs:string" startTime="xs:dateTime"
                endTime="xs:dateTime" expiryTime="xs:dateTime">
            <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                    rel="xs:string"/>
            <Description> xs:string </Description>
            <Tasks> TasksInProgressType </Tasks>
            <Owner href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            <Error message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string" vendorSpecificErrorCode="xs:string"
                    stackTrace="xs:string"/>
            <User href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            <Organization href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            <Progress> xs:int </Progress>
            <Params> ... </Params>
        </Task>
    </Tasks>
    <Owner href="xs:anyURI" type="xs:string">
        <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                rel="xs:string"/>
        <User href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    </Owner>
    <CatalogItems>
        <CatalogItem href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    </CatalogItems>
    <IsPublished> xs:boolean </IsPublished>
</AdminCatalog>

Attributes

Attribute Type Required Modifiable Since Description
href anyURI No always 1.5 Contains the URI to the entity.
type string No always 1.5 Contains the type of the entity.
name string Yes always 1.5 The name of the entity.
id string No none 1.5 The entity identifier, expressed in URN format. The value of this attribute uniquely identifies the entity, persists for the life of the entity, and is never reused.

Elements

Element Type Occurrence Modifiable Since Description
VCloudExtension VCloudExtensionType 0..* always 1.5 An optional extension element that can contain an arbitrary number of elements and attributes.
Link LinkType 0..* none 1.5 Optional link to an entity or operation associated with this object.
Description string 0..1 always 1.5 Optional description.
Tasks TasksInProgressType 0..1 none 1.5 A list of queued, running, or recently completed tasks associated with this entity.
Owner OwnerType 0..1 none 1.5 Catalog owner.
CatalogItems CatalogItemsType 0..1 always 1.5 List of catalog items in the catalog.
IsPublished boolean 0..1 always 1.5 True if the catalog is published, false otherwise. Note that this value is treated as a read only value by the server. Use the 'publish' action to control publishing settings.

Operations

CRUD Operation Description Since
create POST /admin/org/{id}/catalogs Creates a catalog in an organization. 0.9
read GET /admin/catalog/{id} Retrieves a catalog. 0.9
update PUT /admin/catalog/{id} Modifies a catalog. 0.9
delete DELETE /admin/catalog/{id} Deletes a catalog. 0.9
action POST /admin/catalog/{id}/action/publish Publish a catalog. 1.0