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
n
getWorkflowForID
Find Workflows by Using the getAllWorkflows Operation
The getAllWorkflows operation lists all workflows that a user can access as an array of Workflow objects.
Because the getAllWorkflows operation returns Workflow objects that contain all the information about a
workflow, it is useful for applications that require full information about workflows, such as the workflow's
name, ID, description, parameters, and attributes.
Prerequisites
You must have implemented Web service operations in your client application to find objects in the
Orchestrator server.
Procedure
u
Create an array of Workflow objects by calling the getAllWorkflows operation.
Workflow[] workflows = vsoWebControl.getAllWorkflows(username, password);
The preceding code example calls getAllWorkflows to get an array of Workflow objects that the Web
service client can run.
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.
Retrieve the ID of a Workflow
Every workflow has a unique ID that you can retrieve by using the Orchestrator client and a text editor. You
need the workflow ID to perform operations over a workflow by using the Orchestrator SOAP API.
Procedure
1 In the Orchestrator client, select the Workflows view.
2 From the workflow library, select the workflow whose ID you want to retrieve and press Ctrl+C.
3 Open a text editor and press Ctrl+V.
The workflow name and ID appear in the text editor.
Find Workflows by Using the getWorkflowsWithName Operation
If you know the name of a particular workflow, as it is defined in the Orchestrator client, the Web service
application can obtain this workflow using its name or part of its name.
The getWorkflowsWithName operation returns an array of workflows, so you can use it to match several
workflows by using wildcards.
Prerequisites
You must have implemented Web service operations in your client application to find objects in the
Orchestrator server.
Developing a Web Services Client for VMware vCenter Orchestrator
62 VMware, Inc.