4.0

Web Service Application Examples
Orchestrator provides working examples of Web services client applications that provide Web access to
Orchestrator.
You can download the Orchestrator examples ZIP file from the VMware vCenter Orchestrator Documentation
download page. For information about where to find the documentation download page, see “Example
Applications,” on page 9.
Web Service API Object Reference
The Orchestrator Web service API provides a collection of objects that serve as WSDL complex types and a
collection of methods that server as WSDL operations.
FinderResult Object
A FinderResult represents an object from the Orchestrator inventory that Orchestrator locates in an external
application by using a plug-in. For example, a FinderResult object can represent a virtual machine from
vCenter Server.
FinderResult objects represent any object that a plug-in registers with Orchestrator in its vso.xml file.
FinderResult objects represent the items, from all installed plug-ins, that you find when you call one of the
find* operations. The items returned can be any type of object that an Orchestrator plug-in defines. Most
workflows require FinderResult instances as input parameters, as most workflows act upon Orchestrator
objects.
You cannot set a FinderResult as a workflow attribute directly. You must set WorkflowTokenAttribute in
workflows instead, which take the type and the dunesUri from FinderResult objects.
The find operation finds objects according to query criteria that the vso.xml file defines. It does not return
FinderResult objects directly, but returns QueryResult objects instead. QueryResult objects contain arrays of
FinderResult objects.
The objects searched for can also be identified by ID or by relation using the findForId and findRelation
operations, as the following example shows.
public FinderResult findForId(String type, String id, String username, String password);
public FinderResult[] findRelation(String parentType, String parentId, String relation, String
username, String password);
NOTE FinderResult is not an Orchestrator scriptable object.
The following table shows the properties of the FinderResult object.
Type Value Description
String
type
Type of object found.
String
id
ID of the discovered object.
Array of
properties
properties
A list of the discovered object's properties.
The format of the properties values is defined by each plug-in in its vso.xml file, under
the FinderResult description.
String
dunesUri
A string representation of the object.
If a FinderResult object is accessed through a plug-in, it is identified by a dunesUri string,
rather than by another type of string or ID. The format of the dunesUri is as follows.
dunes://service.dunes.ch/CustomSDKObject?id='
<object_ID> '
&dunesName=' <plug-in_name> : <object_type> '
vCenter Orchestrator Developer's Guide
262 VMware, Inc.