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
3 Make a GET request at the URL of the user interaction instance:
GET https://{orchestrator_host}:
{port}/vco/api/workflows/{workflowID}/executions/{executionID}/interaction/
In the response body, you nd a down link to the presentation of the user interaction.
4 Make a GET request at the URL of the presentation of the user interaction:
GET https://{orchestrator_host}:
{port}/vco/api/workflows/{workflowID}/executions/{executionID}/interaction/presentation/
You receive the denition of the user interaction presentation in the response body.
5 In the presentation denition, check for constraints of the values that you can pass to the input
parameters.
6 Run the user interation presentation by making a POST request at the URL where the instances of the
presentation reside:
POST https://{orchestrator_host}:
{port}/vco/api/workflows/{workflowID}/executions/{executionID}/interaction/presentation/insta
nces/
7 In the request body, provide values for the input parameters in an execution-context element.
In the response body, you receive the instance of the user interaction presentation. If the values that you
passed to the input parameters are valid, you nd a valid="true" aribute in the execution element. In
the output-parameters element, you nd the valid values for the input parameters that you can use to
answer to the user interaction.
8 Answer to the user interaction by making a POST request at the URL where the user interaction instance
resides:
POST https://{orchestrator_host}:
{port}/vco/api/workflows/{workflowID}/executions/{executionID}/interaction/
9 In the request body, pass an execution-context context with the values for the input parameters.
You can use the same request body as the one for the POST request that you made at the URL for the
user interaction presentation.
If the last request is successful, you receive a status code 204 and an empty response body.
Example: Answer to the User Interaction of the Interactive Hello World Workflow by Validating Input
Parameters
You can answer to the user interaction of the Interactive Hello World workow by validating the values of
the input parameters against the constraints that are dened in the presentation of the user interaction.
1 Search for the waiting user interactions of the workow by making a GET request at the endpoint for the
user interaction objects of the Catalog service:
GET https://localhost:8281/vco/api/catalog/System/UserInteraction?status=0
2 Locate the user interaction inventory object for the Interactive Hello World workow and make a GET
request at its URL:
GET https://localhost:
8281/vco/api/catalog/System/UserInteraction/888080808080808080808080808080805A808080013214533
8690643f66a027ec/
Chapter 3 Using the vRealize Orchestrator REST API
VMware, Inc. 27