VMware Cloud Director API - CatalogItem

CatalogItemType

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+json
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" id="xs:string" operationKey="xs:string"
        name="xs:string" size="xs:long">
    <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
            rel="xs:string" model="xs:string"/>
    <Description> xs:string </Description>
    <Tasks>
        <Task href="xs:anyURI" type="xs:string" id="xs:string" operationKey="xs:string"
                name="xs:string" status="xs:string" operation="xs:string" operationName="xs:string"
                serviceNamespace="xs:string" startTime="xs:dateTime" endTime="xs:dateTime" expiryTime="xs:dateTime"
                cancelRequested="xs:boolean">
            <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                    rel="xs:string" model="xs:string"/>
            <Description> xs:string </Description>
            <Tasks> TasksInProgressType </Tasks>
            <Owner href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            <Error stackTrace="xs:string" message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string"
                    vendorSpecificErrorCode="xs:string">
                <TenantError message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string" vendorSpecificErrorCode="xs:string"/>
            </Error>
            <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>
            <Details> xs:string </Details>
            <VcTaskList>
                <VcTask name="xs:string" moref="xs:string" status="xs:string" description="xs:string"
                        errorMessage="xs:string" objectName="xs:string" objectType="xs:string" objectMoref="xs:string"
                        virtualCenterID="xs:string" startTime="xs:dateTime" endTime="xs:dateTime"/>
            </VcTaskList>
            <Result>
                <ResultContent> ... </ResultContent>
                <ResultReference href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            </Result>
        </Task>
    </Tasks>
    <Entity href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    <DateCreated> xs:dateTime </DateCreated>
    <VersionNumber> xs:long </VersionNumber>
    <AppVersion> xs:string </AppVersion>
</CatalogItem>

Attributes

Attribute	Type	Required	Modifiable	Since	Description
href	anyURI	No	always	0.9	The URI of the entity.
type	string	No	always	0.9	The MIME type 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.
operationKey	string	No	create	5.1	Optional unique identifier to support idempotent semantics for create and delete operations.
name	string	Yes	always	0.9	The name of the entity.
size	long	No	create	5.5	Size of the catalog item, in bytes. It is optional for a vApp template.

Elements

Element	Type	Required	Modifiable	Since	Description
AppVersion	string	No	always	38.0	Represents the App version number of the catalog item
DateCreated	dateTime	No	none	5.1	Creation date and time of the catalog item.
Description	string	No	always	0.9	Optional description.
Entity	ReferenceType	Yes	always	0.9	A reference to a VAppTemplate or Media object.
Link	LinkType	No	none	0.9	A reference to an entity or operation associated with this object.
Tasks	TasksInProgressType	No	none	0.9	A list of queued, running, or recently completed tasks associated with this entity.
VCloudExtension	VCloudExtensionType	No	always	0.9	An optional extension element that can contain an arbitrary number of elements and attributes. Not related to extension services.
VersionNumber	long	No	none	5.5	Represents the current version number of the catalog item

Operations

CRUD	Operation	Description	Since
create	POST /catalog/{id}/action/upload	Upload a vApp template to a catalog	5.5
create	POST /catalog/{id}/catalogItems	Add an item to a catalog.	0.9
read	GET /catalogItem/{id}	Retrieve a catalog item.	0.9
update	PUT /catalogItem/{id}	Modify a catalog item.	0.9
delete	DELETE /catalogItem/{id}	Delete a catalog item.	0.9