AdminApiDefinitionType

Element:
ApiDefinition (extension/v1.5)
Type:
AdminApiDefinitionType
Namespace:
http://www.vmware.com/vcloud/extension/v1.5
Description:
Represents an extension service API definition.
Since:
5.1
Schema:
services.xsd
Media type(s):
application/vnd.vmware.admin.apiDefinition+xml
Extends:
EntityType
XML Representation:
<ApiDefinition 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"/>
    <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"/>
            <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 message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string" vendorSpecificErrorCode="xs:string"
                    stackTrace="xs:string"/>
            <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:Task>
    </vcloud_v1.5:Tasks>
    <EntryPoint> xs:string </EntryPoint>
    <Namespace> xs:string </Namespace>
    <ApiVendor> xs:string </ApiVendor>
    <SupportedApiVersions>
        <Version> xs:string </Version>
    </SupportedApiVersions>
    <Files>
        <FileDescriptor href="xs:anyURI" type="xs:string" id="xs:string" operationKey="xs:string">
            <vcloud_v1.5:Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                    rel="xs:string"/>
            <Description> xs:string </Description>
            <vcloud_v1.5:File href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
        </FileDescriptor>
    </Files>
</ApiDefinition>

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
ApiVendor string No always 5.1 The name of the external service API vendor. Not required to be the same as the vendor of the external service this API definition is associated with. Must be <=255 characters.
Description string No always 5.1 Optional description.
EntryPoint string No always 5.1 The URL to which a client can send requests to this extension service API. URL string must be <=255 characters. Can include the variable {baseUri}, which represents the vCloud Director REST API base URL.
Files AdminFileDescriptorsType No always 5.1 List of files associated with this extension service API definition.
Link LinkType No none 5.1 A reference to an entity or operation associated with this object.
Namespace string No always 5.1 The namespace of this external service API definition. Must be <=255 characters.
SupportedApiVersions VersionsType (extension/v1.5) No always 5.1 Supported extension service API versions.
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
create POST /admin/extension/service/{id}/apidefinitions Creates API definition. 5.1
read GET /admin/extension/service/apidefinition/{id} Retrieve API definition. 5.1
delete DELETE /admin/extension/service/apidefinition/{id} Deletes API definition. 5.1