CatalogType

Element:

Catalog

Type:

CatalogType

Namespace:

http://www.vmware.com/vcloud/v1.5

Description:

Represents the user view of a Catalog object.

Since:

0.9

Schema:

catalog.xsd

Media type(s):

application/vnd.vmware.vcloud.catalog+xml
application/vnd.vmware.vcloud.catalog+json

Extends:

EntityType

XML Representation:

<Catalog xmlns="http://www.vmware.com/vcloud/v1.5" href="xs:anyURI" type="xs:string" id="xs:string" operationKey="xs:string"
        name="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" 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"/>
            <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>
            <Result>
                <ResultContent> ... </ResultContent>
            </Result>
        </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>
    <DateCreated> xs:dateTime </DateCreated>
    <VersionNumber> xs:long </VersionNumber>
</Catalog>

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.

Elements

Element	Type	Required	Modifiable	Since	Description
CatalogItems	CatalogItemsType	No	always	0.9	Container for CatalogItem elements.
DateCreated	dateTime	No	none	5.1	Creation date and time of the catalog.
Description	string	No	always	0.9	Optional description.
IsPublished	boolean	No	always	0.9	True if the catalog is shared with all other organizations in the system. This value is read-only in the user view. To modify it, an administrator must use the publish link in the admin view of the catalog.
Link	LinkType	No	none	0.9	A reference to an entity or operation associated with this object.
Owner	OwnerType	No	none	0.9	Catalog owner.
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.

Operations

CRUD	Operation	Description	Since	Deprecated
read	GET /catalog/{id}	Retrieve a catalog.	0.9