VMware Cloud Director API - ApiDefinitions

VMware Cloud Director API - ApiDefinitions

AdminApiDefinitionsType

Element:
ApiDefinitions
Type:
AdminApiDefinitionsType
Namespace:
http://www.vmware.com/vcloud/extension/v1.5
Description:
Represents a list of extension service API definitions.
Since:
5.1
Schema:
services.xsd
Media type(s):
None
Extends:
VCloudExtensibleType
XML Representation:
<ApiDefinitions xmlns="http://www.vmware.com/vcloud/extension/v1.5" xmlns:vcloud_v1.5="http://www.vmware.com/vcloud/v1.5">
    <ApiDefinition 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>
        <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" model="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>
</ApiDefinitions>

Elements

Element Type Required Modifiable Since Deprecated Description
ApiDefinition AdminApiDefinitionType No always 5.1 Represents a single extension service API definition.
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.