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
2 Retrieve the denition of the workow presentation by making a GET request at its URL:
GET https://{orchestrator_host}:{port}/vco/api/workflows/{workflowID}/presentation/
3 In the response body of the request, examine the denition of the workow presentation for any
constraints of the values that you can pass to the input parameters.
For example, an input parameter can have a predened list of values to choose from.
4 Instantiate the workow presentation by making a POST request at the URL of the presentation
instances:
POST https://{orchestrator_host}:
{port}/vco/api/workflows/{workflowID}/presentation/instances/
5 Provide an execution-context element in the request body to instantiate the presentation.
You can pass an empty execution-context or pass an execution-context with values only for some of
the input parameters.
6 To pass values to the input parameters in parts, make as many POST or PUT requests as needed at the
URL that holds the presentation instance:
PUT https://{orchestrator_host}:
{port}/vco/api/workflows/{workflowID}/presentation/instances/{executionID}/
7 Review the response body of the POST or PUT request that you made.
If the values that you passed to the input parameters are valid, you nd a valid="true" aribute in the
execution tag. If the presentation is valid, you can take the values that are listed in the out-parameters
element of the response, and pass them as values to the input parameters when you run the workow.
8 If the values for the input parameters are valid, run the workow by making a POST request at the URL
that holds the workow executions:
POST https://{orchestrator_host}:{port}/vco/api/workflows/{workflowID}/executions/
9 Provide the valid values to the input parameters of the workow in an execution-context element.
Example: Run the Send Hello Workflow by Validating Its Input Parameters
You can run the Send Hello workow by validating its input parameters against the denitions of its
presentation.
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"
Chapter 3 Using the vRealize Orchestrator REST API
VMware, Inc. 21