1.5

Searching In a Category
You can enter a search string in the Quick Index text box to search the lists of operations, elements, and types
in any category.
n
In an Operations list, you can search for the following items:
n
All or part of the name of the object on which you want to operate. The search returns a list of all of
the operations that are possible on that object. For example, selecting User Operations and typing
vApp in the Quick Index text box returns a list of all of the requests that operate on a vApp object.
n
The name of an action to perform. For example, selecting User Operations and typing power in the
Quick Index text box returns a list of all the requests that change the power state of a vApp.
n
An HTTP verb (GET, PUT, POST, DELETE) to view a list of all the requests that use that verb. For
example, selecting User Operations and typing PUT in the Quick Index text box returns a list of all of
the requests that update an object.
n
In an Elements or Types list, type all or part of the element or type name.
Search terms are not case-sensitive.
Operation Summary Syntax
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 /object_type/{id}[/action/action_name]
In this syntax, the initial / character is assumed to follow a site-specific API URL, such as
https://vcloud.example.com/api. The following strings represent variables in the remainder of the URL:
HTTP_VERB
The HTTP verb used to request the operation.
object_type
An abbreviation of the MIME type of the object referenced by the operation.
This abbreviation is constructed from the final component of the object's media
type, between the . and the +xml designation. For example, for an object whose
media type is application/vnd.vmware.vcloud.catalogItem+xml, the
object_type is shown as catalogItem.
{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/.
Element and Type Reference Pages
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 name of the type that the element extends.
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 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.
vCloud API Programming Guide
20 VMware, Inc.