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
href="https://localhost:
8281/vco/api/workflows/CF808080808080808080808080808080DA808080013086668236014a0614d16e1/ico
n/" />
</relations>
<input-parameters>
<parameter name="name" type="string" />
</input-parameters>
<output-parameters>
<parameter name="message" type="string" />
</output-parameters>
<name>Send Hello</name>
<description></description>
</workflow>
2 Make a POST request at the URL that holds the execution objects for the workow:
POST https://localhost:
8281/vco/api/workflows/CF808080808080808080808080808080DA808080013086668236014a0614d16e1/exec
utions/
Pass values for the input parameters in an execution-context element in the request body:
<execution-context xmlns="http://www.vmware.com/vco">
<parameters>
<parameter name="name" type="string">
<string>John Smith</string>
</parameter>
</parameters>
</execution-context>
Run a Workflow After Validating Its Input Parameters Against the Workflow
Presentation
The presentation of a workow can dene constraints for the values that you can pass to the input
parameters of the workow, such as a predened list of values or a certain range of values. To ensure that
the workow runs successfully, you must validate the values that you pass to the input parameters of the
workow against the denition of the workow presentation.
When you integrate workows in custom applications, you might need to create a wizard where you enter
values for the input parameters of the workow when you run it. By using the Workow Presentation
service, you can instantiate the presentation of a workow and pass values for its input parameters in parts
that correspond to the dierent screens of the wizard. You can validate the values that you pass to the input
parameters against the constraints that are dened in the workow presentation.
Prerequisites
Verify that you have imported the sample workows package in Orchestrator. The package is included in
the Orchestrator sample applications ZIP le that you can download from the Orchestrator documentation
page.
Procedure
1 Retrieve the denition of the workow that you want to run by making a GET request at the URL that
contains the workow denition:
GET https://{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.
Developing a Web Services Client for VMware vRealize Orchestrator
20 VMware, Inc.