VMware Cloud Director API - Service (v1.5)

ServiceType

Element:

Service (v1.5)

Type:

ServiceType

Namespace:

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

Description:

Public representation of an external service.

Since:

5.1

Deprecated:

39.0

Schema:

services.xsd

Media type(s):

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

Extends:

EntityType

XML Representation:

<Service 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" 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>
    <Namespace> xs:string </Namespace>
    <Vendor> xs:string </Vendor>
</Service>

Attributes

Attribute	Type	Required	Modifiable	Since	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	Description
Description	string	No	always	5.1	Optional description.
Link	LinkType	No	none	5.1	A reference to an entity or operation associated with this object.
Namespace	string	No	none	5.1	Namespace for the service.
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.
Vendor	string	No	none	5.1	External service vendor.

Operations

CRUD	Operation	Description	Since	Deprecated
read	GET /service/{id}	Return the Extension Service API Definition.		39.0