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
Setting Permissions on Orchestrator Objects 39
REST API Permissions 40
Retrieve the Permissions of a Workflow 40
Delete the Permissions of a Workflow 41
Set the Permissions for a Workflow 41
Retrieve the Permissions of an Action 41
Delete the Permissions of an Action 42
Set the Permissions for an Action 42
Retrieve the Permissions of a Package 42
Delete the Permissions of a Package 43
Set the Permissions for a Package 43
Retrieve the Permissions of a Resource 43
Delete the Permissions of a Resource 44
Set the Permissions for a Resource 44
Retrieve the Permissions of a Configuration Element 44
Delete the Permissions of a Configuration Element 45
Set the Permissions for a Configuration Element 45
Performing Operations with Plug-Ins 45
Retrieve Information About Plug-Ins 45
Import a Plug-In 46
Export a Plug-In 46
Enable or Disable a Plug-In 46
Performing Server Configuration Operations 47
Retrieve Information About the Orchestrator Server Configuration 47
Import Orchestrator Server Configuration 47
Export Orchestrator Server Configuration 47
Performing Tagging Operations 48
Tag an Object 48
Untag an Object 48
List Object Tags 49
List Tagged Objects by Type 49
List Tag Owners 49
List Tags by Users 50
List Tags by Users Filtered by Tag Name 50
Remove Tags by Users 50
3
Writing a Client Application for the Orchestrator SOAP Service 53
Process for Creating an Orchestrator Web Service Client Application 53
Web Service Endpoint 55
Generating the Orchestrator Web Service Stubs 55
Accessing the Server from Web Service Clients 56
Create a Web Service Client 56
Connect to the Orchestrator Web Service 57
Find Objects in the Orchestrator Server 58
Find Objects by Using the find Operation 58
Find Objects by Using the findForId Operation 59
Find Objects by Using the findRelation Operation 60
Find Workflows in the Orchestrator Server 61
Find Workflows by Using the getAllWorkflows Operation 62
Developing a Web Services Client for VMware vCenter Orchestrator
4 VMware, Inc.