CatalogItem

Element:
CatalogItem
Type:
CatalogItemType
Namespace:
http://www.vmware.com/vcloud/v1.5
Description:
Contains a reference to a VappTemplate or Media object and related metadata.
Since:
0.9
Schema:
catalogItem.xsd
Media type(s):
application/vnd.vmware.vcloud.catalogItem+xml
Extends:
EntityType
XML Representation:
<CatalogItem 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>
    <Entity href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    <Property key="xs:string"/>
</CatalogItem>

Attributes

Attribute Type Required Modifiable Since Description
href anyURI No always 0.9 Contains the URI to the entity.
type string No always 0.9 Contains the type of the entity.
name string Yes always 0.9 The name of the entity.
id string No none 0.9 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 0.9 An optional extension element that can contain an arbitrary number of elements and attributes.
Link LinkType 0..* none 0.9 Optional link to an entity or operation associated with this object.
Description string 0..1 always 0.9 Optional description.
Tasks TasksInProgressType 0..1 none 0.9 A list of queued, running, or recently completed tasks associated with this entity.
Entity ReferenceType 1 always 0.9 A reference to a VappTemplate or Media object.
Property PropertyType 0..* always 0.9 User-specified key/value pair. This element has been superseded by the Metadata element, which is the preferred way to specify key/value pairs for objects.

Operations

CRUD Operation Description Since
create POST /catalog/{id}/catalogItems Creates a catalog item in a catalog. 0.9
read GET /catalogItem/{id} Retrieves a catalog item. 0.9
update PUT /catalogItem/{id} Modifies a catalog item. 0.9
delete DELETE /catalogItem/{id} Deletes a catalog item. 0.9