The vCloud Air Platform APIs Schema Reference includes reference material for all elements, types, operations, and queries in the vCloud Air Platform APIs.
You can download an archive of XML schema definition files (*.xsd) for the vCloud Air Platform APIs.
The schema reference documentation provides reference information for elements, types, and operations.
If you are viewing the schema reference in a VMware Documentation Center, click the icon in the ocumentation Center main frame to dismiss the Documentation Center table of contents. The schema reference provides its own search facility. You cannot search for schema reference content in the main Documentation Center search window.
You can enter a search string in the Quick Index text box to search the lists of operations, elements, and types in any category.
■
|
In an Operations list, you can search for the following items:
|
||||||
■
|
In an Elements or Types list, type all or part of the element or type name. |
Search terms are not case-sensitive.
Operations consist of an HTTP verb and a request URL. The reference documentation represents the verb and the URL using the following syntax:
HTTP_VERB /api/api_surface/ object_type /{id}[/action/ action_name ]
The following strings represent variables in the remainder of the URL:
HTTP_VERB |
The HTTP verb used to request the operation. |
api/api_surface |
The API surface to which the operation belongs; namely, the Service Controller, Identity Management, and Metering. |
object_type |
The object referenced by the operation. |
{id} |
The unique identifier of the object of the operation. |
action_name |
The name of an action. Required only when the operation request URL includes the string /action/ . |
For each element or complex type, the reference documentation provides a page that lists the following items:
Element |
The name of the element. |
||||||||||||||||||||||
Type |
The type of the element. |
||||||||||||||||||||||
Namespace |
The XML namespace in which this element or type name is defined. |
||||||||||||||||||||||
Description |
A description of the purpose and contents of the element or type. |
||||||||||||||||||||||
Since |
The vCloud Air API version in which this element or type first appeared. |
||||||||||||||||||||||
Schema |
The name of the XML schema definition file in which this element or type is defined. Click to open the file in your browser, or right-click to download it. |
||||||||||||||||||||||
Media Type |
The MIME type associated with this element or type. |
||||||||||||||||||||||
Extends |
The abstract base type from which this element's type is derived. |
||||||||||||||||||||||
XML Representation |
The XML representation of the element or type. Names of contained elements are links to the reference pages for those elements. |
||||||||||||||||||||||
Attributes |
A table listing the following properties of each attribute of the element or type:
|
||||||||||||||||||||||
Elements |
A table listing the following properties of each element defined in the type:
|