5.5.1
Table Of Contents
- Developing a Web Services Client for VMware vCenter Orchestrator
- Contents
- Developing Web Services Client for VMware vCenter Orchestrator
- Developing a Web Services Client
- Using the vCenter Orchestrator REST API
- Authenticating Against Orchestrator and Third-Party Systems
- Accessing the Reference Documentation for the Orchestrator REST API
- Using the Java REST SDK
- Operations with Workflows
- Working with Tasks
- Finding Objects in the Orchestrator Inventory
- Importing and Exporting Orchestrator Objects
- Deleting Orchestrator Objects
- Setting Permissions on Orchestrator Objects
- REST API Permissions
- Retrieve the Permissions of a Workflow
- Delete the Permissions of a Workflow
- Set the Permissions for a Workflow
- Retrieve the Permissions of an Action
- Delete the Permissions of an Action
- Set the Permissions for an Action
- Retrieve the Permissions of a Package
- Delete the Permissions of a Package
- Set the Permissions for a Package
- Retrieve the Permissions of a Resource
- Delete the Permissions of a Resource
- Set the Permissions for a Resource
- Retrieve the Permissions of a Configuration Element
- Delete the Permissions of a Configuration Element
- Set the Permissions for a Configuration Element
- Performing Operations with Plug-Ins
- Performing Server Configuration Operations
- Performing Tagging Operations
- Writing a Client Application for the Orchestrator SOAP Service
- Process for Creating an Orchestrator Web Service Client Application
- Web Service Endpoint
- Generating the Orchestrator Web Service Stubs
- Accessing the Server from Web Service Clients
- Create a Web Service Client
- Connect to the Orchestrator Web Service
- Find Objects in the Orchestrator Server
- Find Objects by Using the find Operation
- Find Objects by Using the findForId Operation
- Find Objects by Using the findRelation Operation
- Find Workflows in the Orchestrator Server
- Find Workflows by Using the getAllWorkflows Operation
- Retrieve the ID of a Workflow
- Find Workflows by Using the getWorkflowsWithName Operation
- Find Workflows by Using the getWorkflowForID Operation
- Run Workflows from a Web Service Client
- Interact with a Workflow While it Runs
- Obtain Workflow Results
- Time Zones and Running Workflows Through Web Services
- Web Service Application Examples
- Web Service API Object Reference
- Web Service API Operation Reference
- answerWorkflowInput Operation
- cancelWorkflow Operation
- echo Operation
- echoWorkflow Operation
- executeWorkflow Operation
- find Operation
- findForId Operation
- findRelation Operation
- getAllPlugins Operation
- getAllWorkflows Operation
- getWorkflowForId Operation
- getWorkflowInputForId Operation
- getWorkflowInputForWorkflowTokenId Operation
- getWorkflowsWithName Operation
- getWorkflowTokenBusinessState Operation
- getWorkflowTokenForId Operation
- getWorkflowTokenResult Operation
- getWorkflowTokenStatus Operation
- hasChildrenInRelation Operation
- hasRights Operation
- sendCustomEvent Operation
- simpleExecuteWorkflow Operation
- Index
Prerequisites
You must have created a connection to the Orchestrator Web services endpoint in your Web service client
application class.
Procedure
1 Create a FinderResult object by calling the findForId operation on an object.
finderResult = vsoWebControl.findForId("VC:VirtualMachine", "vcenter/vm-xx",
username, password);
In the preceding example, vcenter/vm-xx is the ID of a virtual machine object that the findForID
operation finds.
The findForID operation returns a FinderResult instance directly, rather than creating an array of
FinderResult objects like find. Finding objects by their unique ID always returns only one object.
2 Extract the results from a FinderResult object.
To show, interpret, or process the results in the FinderResult objects that the find operation returns,
you must convey these results to the Web service application.
The following example shows how to extract the results returned in a FinderResult object.
public static void displayFinderResult(FinderResult finderResult) {
if (finderResult != null) {
System.out.println("Finder result is of type '"
+ finderResult.getType()
+ "', id '" + finderResult.getId()
+ "' and uri '"
+ finderResult.getDunesUri() + "'");
System.out.println("And has properties :");
Property[] props = finderResult.getProperties();
if (props != null) {
for (int ii = 0; ii < props.length; ii++) {
System.out.println("\t" + props[ii].getName() + "="
+ props[ii].getValue());
}
}
}
The example defines an internal method, displayFinderResult, which takes a FinderResult object and
obtains and shows its type, ID, the URI at which it is located, and its properties. You can use the URI to
set arguments when starting or answering workflows. The getType, getId, getProperties and
getDunesUri methods are defined by the FinderResult object.
You found objects in the Orchestrator server that the Web service client can access and run workflows upon.
Find Objects by Using the findRelation Operation
You can use the findRelation operation to locate the children of a particular object.
The findRelation operation returns an array of FinderResult objects that correspond to the children of a
particular object.
Prerequisites
You must have created a connection to the Orchestrator Web services endpoint in your Web service client
application class.
Developing a Web Services Client for VMware vCenter Orchestrator
60 VMware, Inc.