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
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/Custom
SDKObject?id='<object_ID>'
&dunesName='<plug-
in_name>:<object_type>'
ModuleInfo Object
ModuleInfo stores the name, version, description, and display name attributes for each plug-in. A Web
service application can use these attributes to modify its behavior based on the presence or absence of
certain plug-ins or plug-in versions.
The getAllPlugins operation returns arrays of ModuleInfo objects to list all the plug-ins a user can access, as
the following example shows.
public ModuleInfo[] getAllPlugins(username, password);
The following table shows the properties of the ModuleInfo object.
Type Value Description
String
moduleName
Name of the plug-in, used as a prefix
in object names.
String
moduleVersion
Plug-in version.
String
moduleDescription
Description of the plug-in.
String
moduleDisplayName
Plug-in name shown in the
Orchestrator inventory.
Developing a Web Services Client for VMware vCenter Orchestrator
70 VMware, Inc.