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 Operation
Reference 5
The Orchestrator Web service API provides a collection of methods that server as WSDL operations.
NOTE Every Web service operation, except echo, echoWorkflow, and sendCustomEvent uses the Orchestrator
user name and password to authenticate the session. The operations throw exceptions if you use the
incorrect username or password.
This chapter includes the following topics:
n
“answerWorkflowInput Operation,” on page 80
n
“cancelWorkflow Operation,” on page 80
n
“echo Operation,” on page 81
n
“echoWorkflow Operation,” on page 81
n
“executeWorkflow Operation,” on page 81
n
“find Operation,” on page 82
n
“findForId Operation,” on page 83
n
“findRelation Operation,” on page 84
n
“getAllPlugins Operation,” on page 86
n
“getAllWorkflows Operation,” on page 86
n
“getWorkflowForId Operation,” on page 87
n
“getWorkflowInputForId Operation,” on page 87
n
“getWorkflowInputForWorkflowTokenId Operation,” on page 88
n
“getWorkflowsWithName Operation,” on page 88
n
“getWorkflowTokenBusinessState Operation,” on page 89
n
“getWorkflowTokenForId Operation,” on page 89
n
“getWorkflowTokenResult Operation,” on page 90
n
“getWorkflowTokenStatus Operation,” on page 90
n
“hasChildrenInRelation Operation,” on page 91
n
“hasRights Operation,” on page 92
n
“sendCustomEvent Operation,” on page 93
n
“simpleExecuteWorkflow Operation,” on page 94
VMware, Inc.
79