EntityType

Element:
Entity
Type:
EntityType
Namespace:
http://www.vmware.com/vcloud/v1.5
Description:
Basic entity type in the vCloud object model. Includes a name, an optional description, and an optional list of links.
Since:
0.9
Schema:
entity.xsd
Media type(s):
application/vnd.vmware.vcloud.entity+xml
Extends:
IdentifiableResourceType
XML Representation:
<Entity 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" name="xs:string" type="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" cancelRequested="xs:boolean" endTime="xs:dateTime" expiryTime="xs:dateTime"
                operation="xs:string" operationName="xs:string" serviceNamespace="xs:string" startTime="xs:dateTime"
                status="xs:string">
            <Link href="xs:anyURI" id="xs:string" name="xs:string" type="xs:string"
                    rel="xs:string"/>
            <Description> xs:string </Description>
            <Tasks> TasksInProgressType </Tasks>
            <Owner href="xs:anyURI" id="xs:string" name="xs:string" type="xs:string"/>
            <Error majorErrorCode="xs:int" message="xs:string" minorErrorCode="xs:string" stackTrace="xs:string"
                    vendorSpecificErrorCode="xs:string"/>
            <User href="xs:anyURI" id="xs:string" name="xs:string" type="xs:string"/>
            <Organization href="xs:anyURI" id="xs:string" name="xs:string" type="xs:string"/>
            <Progress> xs:int </Progress>
            <Params> ... </Params>
            <Details> xs:string </Details>
        </Task>
    </Tasks>
</Entity>

Attributes

Attribute Type Required Modifiable Since Deprecated 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 Deprecated Description
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.
Link LinkType No none 0.9 A reference to an entity or operation associated with this object.
Description string No always 0.9 Optional description.
Tasks TasksInProgressType No none 0.9 A list of queued, running, or recently completed tasks associated with this entity.

Operations

CRUD Operation Description Since Deprecated
read GET /entity/{id} Redirects to the URL of an entity with the given VCD ID. 1.5