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
Index
A
action
delete permissions 42
deleting 38
download 35
export 35
get permissions 41, 42
import 34
retrieve permissions 41, 42
upload 34
answerWorkflowInput 64, 80
API documentation 14
audience 7
authentication
LDAP 14
solution user name 13
vCenter Single Sign-On 12
vco solution user name 13
C
cancelWorkflow 64, 80
configuration element
delete permissions 45
deleting 39
download 37
export 37
get permissions 44, 45
import 37
retrieve permissions 44, 45
upload 37
D
deleting objects 38
dunesUri 69, 76
E
echo operation 57, 81
echoWorkFlow 81
executeWorkflow 81
executeWorkflow operation 63
export 33
F
filters 33
find
by ID 31
by type 31
objects 32
find objects 31
find operation 58
FinderResult 58–60, 69
findForId 83
findForId operation 58, 59
findRelation 58, 60, 84
G
getAllPlugins 86
getAllPlugins operation 57
getAllWorkflows 61, 62, 86
getWorkflowForId 87
getWorkflowForID 61, 63
getWorkflowInputForId 87
getWorkflowInputForWorkflowTokenId 88
getWorkflowsWithName 61, 62, 88
getWorkflowTokenBusinessState 89
getWorkflowTokenForId 64
getWorkflowTokenForID 89
getWorkflowTokenResult 66, 90
getWorkflowTokenStatus 64, 90
globalStatus 90
H
hasChildrenInRelation 91
hasRights 92
hasRights operation 63
I
import 33
inventory, search 31
J
Java REST SDK 14
L
LDAP
authentication 12
vCenter Single Sign-On 12
VMware, Inc. 97