4.1

Table Of Contents
Procedure
u
You can access the API Explorer from either the Orchestrator client or from the Scripting tabs of the
workflow, policy, and action editors.
n
To access the API Explorer from the Orchestrator client, click Tools > API Explorer in the Orchestrator
client tool bar.
n
To access the API Explorer from the Scripting tabs of the workflow, policy, and action editors, click
Search APIon the left.
The API Explorer appears, allowing you to search all the objects and functions of the Orchestrator API.
What to do next
Use the API Explorer to write scripts for scriptable elements.
Use the Orchestrator API Explorer to Find Objects
The Orchestrator API exposes the API of all plugged-in technologies, including the entire vCenter Server API.
The Orchestrator API Explorer helps you find the objects you need to add to scripts.
Prerequisites
The API Explorer is open.
Procedure
1 Enter the name or part of a name of an object in the API Explorer Search text box and click Search.
To limit your search to a particular object type, uncheck or check the Scripting Class, Attributes &
Methods and Types & Enumerations check boxes.
2 Double-click the element in the proposed list.
The object is highlighted in the hierarchical list on the left. A documentation pane under the hierarchical
list presents information about the object.
You found the object you were looking for.
What to do next
Use the objects you find in scripts.
JavaScript Objects in the API Explorer
The Orchestrator API Explorer identifies and groups together the different kinds of JavaScript objects in the
hierarchical tree on the left of the Scripting tab or API Explorer dialog box. The API Explorer uses icons to
help you identify the different kinds of object.
Table 4-1 describes the objects of the Orchestrator API and shows their icon.
Table 4-1. JavaScript Objects in the Orchestrator API
Object Icon in Hierarchical List Description
Type Types
Function set Internal type that contains a set of static
methods
Primitive Primitive types
Object Standard Orchestrator scripting objects
Attribute JavaScript attributes
Chapter 4 Scripting
VMware, Inc. 115