VMware Cloud Director API - StrandedItem

VMware Cloud Director API - StrandedItem

StrandedItemType

Element:
StrandedItem
Type:
StrandedItemType
Namespace:
http://www.vmware.com/vcloud/extension/v1.5
Description:
Represents the stranded item.
Since:
5.1
Schema:
vmwextensions.xsd
Media type(s):
application/vnd.vmware.admin.strandedItem+json
application/vnd.vmware.admin.strandedItem+xml
Extends:
EntityType
XML Representation:
<StrandedItem xmlns="http://www.vmware.com/vcloud/extension/v1.5" xmlns:vcloud_v1.5="http://www.vmware.com/vcloud/v1.5" href="xs:anyURI" type="xs:string" id="xs:string" operationKey="xs:string"
        name="xs:string">
    <vcloud_v1.5:Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
            rel="xs:string" model="xs:string"/>
    <Description> xs:string </Description>
    <vcloud_v1.5:Tasks>
        <vcloud_v1.5: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">
            <vcloud_v1.5:Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                    rel="xs:string" model="xs:string"/>
            <Description> xs:string </Description>
            <vcloud_v1.5:Tasks> vcloud_v1.5:TasksInProgressType </vcloud_v1.5:Tasks>
            <vcloud_v1.5:Owner href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            <vcloud_v1.5:Error stackTrace="xs:string" message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string"
                    vendorSpecificErrorCode="xs:string">
                <vcloud_v1.5:TenantError message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string" vendorSpecificErrorCode="xs:string"/>
            </vcloud_v1.5:Error>
            <vcloud_v1.5:User href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            <vcloud_v1.5:Organization href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            <Progress> xs:int </Progress>
            <Params> ... </Params>
            <Details> xs:string </Details>
            <vcloud_v1.5:VcTaskList>
                <vcloud_v1.5: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"/>
            </vcloud_v1.5:VcTaskList>
            <vcloud_v1.5:Result>
                <ResultContent> ... </ResultContent>
                <vcloud_v1.5:ResultReference href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            </vcloud_v1.5:Result>
        </vcloud_v1.5:Task>
    </vcloud_v1.5:Tasks>
    <EntityType> xs:string </EntityType>
    <DeletionDate> xs:dateTime </DeletionDate>
    <ErrorMessage> xs:string </ErrorMessage>
    <vcloud_v1.5:Parent href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    <StrandedItemVimObjects>
        <StrandedItemVimObject name="xs:string">
            <ErrorMessage> xs:string </ErrorMessage>
            <VimObjectRef>
                <vcloud_v1.5:VimServerRef href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
                <MoRef> xs:string </MoRef>
                <VimObjectType> xs:string </VimObjectType>
            </VimObjectRef>
        </StrandedItemVimObject>
    </StrandedItemVimObjects>
</StrandedItem>

Attributes

Attribute Type Required Modifiable Since Deprecated Description
href anyURI No always 5.1 The URI of the entity.
type string No always 5.1 The MIME type of the entity.
id string No none 5.1 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 5.1 The name of the entity.

Elements

Element Type Required Modifiable Since Deprecated Description
DeletionDate dateTime No none 5.1 Date when the object was deleted from vCD.
Description string No always 5.1 Optional description.
EntityType string No always 5.1 The type of the stranded item.
ErrorMessage string No none 5.1 The reason why the deletion failed.
Link LinkType No none 5.1 A reference to an entity or operation associated with this object.
Parent ReferenceType No none 5.1 A reference to the parent stranded item.
StrandedItemVimObjects StrandedItemVimObjectsType No none 5.1 A collection of stranded item VimObjects.
Tasks TasksInProgressType No none 5.1 A list of queued, running, or recently completed tasks associated with this entity.
VCloudExtension VCloudExtensionType No always 5.1 An optional extension element that can contain an arbitrary number of elements and attributes. Not related to extension services.

Operations

CRUD Operation Description Since Deprecated
read GET /admin/extension/strandedItem/{id} Gets the representation of a strandedItem. 5.1
delete DELETE /admin/extension/strandedItem/{id} Removes stranded item. 5.1