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
M
ModuleInfo 70
O
object, find 31
P
package
delete permissions 43
deleting 38
download 36
export 36
get permissions 42, 43
import 35
retrieve permissions 42, 43
upload 35
permissions 39, 40
plug-in
disable 46
enable 46
export 46
import 46
information retrieval 45
retrieving information 45
plug-ins, operations 45
Property 71
Q
QueryResult 58, 71
R
reference 14
resource
delete permissions 44
deleting 39
download 37
export 37
get permissions 43, 44
import 36
retrieve permissions 43, 44
upload 36
REST API, permissions 39, 40
S
schedule workflow 29
SDK, Java REST 14
sendCustomEvent 93
server configuration
export 47
import 47
operations 47
retrive information 47
simpleExecuteWorkflow 94
T
taggaing, operations 48
tagging
list tags 49
list filtered tags by users 50
list tag owners 49
list tagged objects by type 49
list tags by users 50
remove tags by users 50
tag 48
untag 48
task
check state 30
create 29
modify 30
schedule workflow 29
state 30
V
vCO API 11
vsoWebControl 57
W
waitForCustomEvent 93
Web service
access server 56
client creation process 53
download examples 67
endpoint 55
generating stubs 55
HTTPS connection 57
obtain results 66
operation arguments 55
running workflows 63
WSDL description 55
Web service API
objects 69
operations 79
Web services
create client 56
finding objects 58–60
finding workflows 61–63
time zones 67
workflow interaction 64
writing client application 53
workflow
accessing schema 28
answer to user interaction 24
cancel 28
delete 28
delete permissions 41
deleting 38
download 34
Developing a Web Services Client for VMware vCenter Orchestrator
98 VMware, Inc.