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
Retrieve the ID of a Workflow 62
Find Workflows by Using the getWorkflowsWithName Operation 62
Find Workflows by Using the getWorkflowForID Operation 63
Run Workflows from a Web Service Client 63
Interact with a Workflow While it Runs 64
Obtain Workflow Results 66
Time Zones and Running Workflows Through Web Services 67
Web Service Application Examples 67
4
Web Service API Object Reference 69
FinderResult Object 69
ModuleInfo Object 70
Property Object 71
QueryResult Object 71
Workflow Object 72
WorkflowParameter Object 73
WorkflowToken Object 73
WorkflowTokenAttribute Object 76
5
Web Service API Operation Reference 79
answerWorkflowInput Operation 80
cancelWorkflow Operation 80
echo Operation 81
echoWorkflow Operation 81
executeWorkflow Operation 81
find Operation 82
findForId Operation 83
findRelation Operation 84
getAllPlugins Operation 86
getAllWorkflows Operation 86
getWorkflowForId Operation 87
getWorkflowInputForId Operation 87
getWorkflowInputForWorkflowTokenId Operation 88
getWorkflowsWithName Operation 88
getWorkflowTokenBusinessState Operation 89
getWorkflowTokenForId Operation 89
getWorkflowTokenResult Operation 90
getWorkflowTokenStatus Operation 90
hasChildrenInRelation Operation 91
hasRights Operation 92
sendCustomEvent Operation 93
simpleExecuteWorkflow Operation 94
Index 97
Contents
VMware, Inc. 5