7.1
Table Of Contents
- Developing a Web Services Client for VMware vRealize Orchestrator
- Contents
- Developing a Web Services Client for VMware vRealize Orchestrator
- Updated Information
- Developing a Web Services Client
- Using the vRealize 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
- Index
Procedure
1 Retrieve the denition of the workow that you want to run by making a GET request at the URL of the
denition:
GET http://{orchestrator_host}:{port}/vco/api/workflows/{workflowID}/
You receive the denition of the workow in the response body of the request. In the workow
denition, you can view the input parameters of the workow, the workow description, and other
information.
2 Make a POST request at the URL that holds the execution objects of the workow:
POST https://{orchestrator_host}:{port}/vco/api/workflows/{workflowID}/executions/
3 Provide values for the input parameters of the workow in an execution-context element in the
request body.
If you provide an empty execution-context in the request body, the workow runs with default values
for its input parameters, if any.
If the POST request is successful, you receive the status code 202 with an empty response body and a link to
the newly created execution object in the Location header.
Example: Run the Send Hello Workflow
You can retrieve the denition of the Send Hello workow and run it.
1 Make a GET request at the URL that holds the denition of the Send Hello workow:
GET https://localhost:
8281/vco/api/workflows/CF808080808080808080808080808080DA808080013086668236014a0614d16e1/
You receive the workow denition in the response body of the request:
<xml version="1.0" encoding="UTF-8" standalone="yes">
<workflow xmlns="http://www.vmware.com/vco" customized-icon="false"
href="https://localhost:
8281/vco/api/workflows/CF808080808080808080808080808080DA808080013086668236014a0614d16e1/">
<relations>
<link rel="up"
href="https://localhost:
8281/vco/api/inventory/System/Workflows/Samples/HelloWorld/" />
<link rel="add"
href="https://localhost:
8281/vco/api/workflows/CF808080808080808080808080808080DA808080013086668236014a0614d16e1/exec
utions/" />
<link rel="down"
href="https://localhost:
8281/vco/api/workflows/CF808080808080808080808080808080DA808080013086668236014a0614d16e1/exec
utions/" />
<link rel="down"
href="https://localhost:
8281/vco/api/workflows/CF808080808080808080808080808080DA808080013086668236014a0614d16e1/pres
entation/" />
<link rel="down"
href="https://localhost:
8281/vco/api/workflows/CF808080808080808080808080808080DA808080013086668236014a0614d16e1/task
s/" />
<link rel="down"
Chapter 3 Using the vRealize Orchestrator REST API
VMware, Inc. 19