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
3 Retrieve the definition of the workflow by making a GET request at the URL of the definition:
GET https://{vcoHost}:{port}/vco/api/workflows/{workflowID}/
Example: Search for the Send Hello Workflow
You can find the Send Hello workflow and retrieve its definition:
1 To find the Send Hello workflow, make a GET request at the URL of the Workflow service by applying a
filter:
GET https://localhost:8281/vco/api/workflows?conditions=name~Hello
You receive a list of the workflows that contain Hello in their names:
<xml version="1.0" encoding="UTF-8" standalone="yes">
<inventory-items xmlns="http://www.vmware.com/vco" total="2">
<link rel="down"
href="https://localhost:
8281/vco/api/catalog/System/Workflow/CF808080808080808080808080808080E6808080013086668236014a
0614d16e1/">
<attributes>
<attribute name="id"
value="CF808080808080808080808080808080E6808080013086668236014a0614d16e1"/>
<attribute name="canExecute" value="true" />
<attribute name="description" value="" />
<attribute name="name" value="Interactive Hello World" />
<attribute name="type" value="Workflow"/>
<attribute name="canEdit" value="true"/>
</attributes>
</link>
<link rel="down"
href="https://localhost:
8281/vco/api/catalog/System/Workflow/CF808080808080808080808080808080DA808080013086668236014a
0614d16e1/">
<attributes>
<attribute name="id"
value="CF808080808080808080808080808080DA808080013086668236014a0614d16e1"/>
<attribute name="canExecute" value="true" />
<attribute name="description" value="" />
<attribute name="name" value="Send Hello" />
<attribute name="type" value="Workflow"/>
<attribute name="canEdit" value="true"/>
</attributes>
</link>
</inventory-items>
2 Make a GET request at the URL of the inventory item of the Send Hello workflow:
GET https://localhost:
8281/vco/api/catalog/System/Workflow/CF808080808080808080808080808080DA808080013086668236014a
0614d16e1/
You receive the inventory item of the Send Hello workflow in the response body:
<xml version="1.0" encoding="UTF-8" standalone="yes">
<inventory-item xmlns="http://www.vmware.com/vco"
href="https://localhost:
8281/vco/api/catalog/System/Workflow/CF808080808080808080808080808080DA808080013086668236014a
0614d16e1/">
Developing a Web Services Client for VMware vCenter Orchestrator
16 VMware, Inc.