VMware Cloud Director API - CatalogRecord

QueryResultCatalogRecordType

Element:

CatalogRecord

Type:

Namespace:

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

Description:

Type for a single catalog query result in records format.

Since:

1.5

Schema:

queryRecordView.xsd

Media type(s):

None

Extends:

QueryResultRecordType

XML Representation:

<CatalogRecord xmlns="http://www.vmware.com/vcloud/v1.5" href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
        description="xs:string" isPublished="xs:boolean" isShared="xs:boolean" creationDate="xs:dateTime"
        orgName="xs:string" ownerName="xs:string" numberOfVAppTemplates="xs:int" numberOfMedia="xs:int"
        owner="xs:string" publishSubscriptionType="xs:string" version="xs:long" status="xs:string"
        isLocal="xs:boolean" isSharedWithManagedOrgs="xs:boolean" isDistributed="xs:boolean" isHealthy="xs:boolean"
        isSharedWithPeersParentManagedOrgs="xs:boolean" isPrimary="xs:boolean" boundAccessLevel="xs:string">
    <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
            rel="xs:string" model="xs:string"/>
    <Metadata href="xs:anyURI" type="xs:string">
        <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                rel="xs:string" model="xs:string"/>
        <MetadataEntry href="xs:anyURI" type="xs:string">
            <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                    rel="xs:string" model="xs:string"/>
            <Domain visibility="xs:string"/>
            <Key> xs:string </Key>
            <TypedValue/>
        </MetadataEntry>
    </Metadata>
</CatalogRecord>

Attributes

Attribute	Type	Required	Modifiable	Since	Description	Filter	Sort
href	anyURI	No	always	1.5	Contains the URI to the resource.	Yes	Yes
id	string	No	always	1.5	The resource identifier, expressed in URN format. The value of this attribute uniquely identifies the resource, persists for the life of the resource, and is never reused.	Yes	Yes
type	string	No	always	1.5	Contains the type of the resource.	Yes	Yes
name	string	No	none	1.5	The name of this catalog.	Yes	Yes
description	string	No	none	30.0	Catalog description	Yes	Yes
isPublished	boolean	No	none	1.5	True if this catalog is shared to all organizations.	Yes	Yes
isShared	boolean	No	none	1.5	True if this catalog is shared.	Yes	Yes
creationDate	dateTime	No	none	1.5	Creation date	Yes	Yes
orgName	string	No	none	1.5	Organization name	Yes	Yes
ownerName	string	No	none	1.5	Owner name	Yes	Yes
numberOfVAppTemplates	int	No	none	1.5	Number of vApp templates	Yes	Yes
numberOfMedia	int	No	none	1.5	Number of media	Yes	Yes
owner	string	No	none	1.5	Owner reference or id	Yes	Yes
publishSubscriptionType	string	No	none	30.0	PUBLISHED if published externally, SUBSCRIBED if subscribed to an external catalog, UNPUBLISHED otherwise.	Yes	Yes
version	long	No	none	30.0	Version	Yes	Yes
status	string	No	none	30.0	Status	Yes	Yes
isLocal	boolean	No	none	35.0	True if Catalog belongs to organization, false when catalog is shared with other organization.	Yes	Yes
isSharedWithManagedOrgs	boolean	No	none	39.0	True if the catalog is shared with all organizations in the system managed by the organization the catalog belongs to.	Yes	Yes
isDistributed	boolean	No	none	39.0	True if this entity is distributed.	Yes	Yes
isHealthy	boolean	No	none	39.0	True if everything about the catalog is in an expected state.	Yes	Yes
isSharedWithPeersParentManagedOrgs	boolean	No	none	39.0	True if the catalog is shared with all organizations in the system managed by the organization the catalog belongs to as well as all peer organizations.	Yes	Yes
isPrimary	boolean	No	none	39.0	True if the catalog is the primary distributed catalog or false if it is a bound catalog.	Yes	Yes
boundAccessLevel	string	No	none	39.0	Default access level that the author of the catalog wants to grant to all the other consumers that want to bind to this distributed catalog.	Yes	Yes

Elements

Element	Type	Required	Modifiable	Since	Deprecated	Description
Link	LinkType	No	none	1.5		Contains a link to an operation associated with a specific relation type.
Metadata	MetadataType	No		5.1