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
Web Service API Object Reference 4
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.
This chapter includes the following topics:
n
“FinderResult Object,” on page 69
n
“ModuleInfo Object,” on page 70
n
“Property Object,” on page 71
n
“QueryResult Object,” on page 71
n
“Workflow Object,” on page 72
n
“WorkflowParameter Object,” on page 73
n
“WorkflowToken Object,” on page 73
n
“WorkflowTokenAttribute Object,” on page 76
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.
VMware, Inc.
69