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
Procedure
u
Create an array of Workflow objects by calling the getWorkflowsWithName operation.
Workflow[] workflows =
vsoWebControl.getWorkflowsWithName("Simple user interaction",
username, password);
The preceding code example calls the getWorkflowsWithName operation to obtain all workflows for
which the name, or part of the name, is Simple user interaction.
You found workflows in the Orchestrator server that the Web service client can run on objects.
What to do next
Implement operations in the Web services client to run the workflows it finds.
Find Workflows by Using the getWorkflowForID Operation
If you know a particular workflow ID, a Web service application can obtain this workflow by using the
getWorkflowForID operation.
The getWorkflowForID operation returns a single Workflow instance, because all workflow IDs are unique.
Prerequisites
You must have implemented Web service operations in your client application to find objects in the
Orchestrator server.
Procedure
u
Create a Workflow object by calling the getWorkflowForID operation.
String workflowId = "1880808080808080808080808080808087808080011713796199469943be4c882";
Workflow workflow = vsoWebControl.getWorkflowForID(workflowId, username, password);
You found a workflow in the Orchestrator server that the Web service client can run on objects.
What to do next
Implement operations in the Web services client to run the workflows it finds.
Run Workflows from a Web Service Client
The main purpose of a Web services client is to run workflows across a network.
Prerequisites
You must have implemented Web service operations in the client to find workflows in the Orchestrator
server.
Procedure
1 (Optional) Check the workflow user permissions by calling the hasRights operation.
You can verify if a user has rights to read, run, or edit a particular workflow using the hasRights
operation. This operation is not mandatory, but checking user rights before you run a workflow can
help prevent exceptions.
String workflowId = "1880808080808080808080808080808087808080011713796199469943be4c882";
Boolean rights = vsoWebControl.hasRights(workflowId, username, password, 'x');
The preceding code example calls the hasRights operation to discover whether the user has the right to
run the workflow identified by workflowId.
Chapter 3 Writing a Client Application for the Orchestrator SOAP Service
VMware, Inc. 63