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 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/
3 Make a POST request at the URL of the user interation objects for the currently running workow
execution:
POST https://localhost:
8281/vco/api/workflows/CF808080808080808080808080808080E6808080013086668236014a0614d16e1/exec
utions/88808080808080808080808080808080578080800132145338690643f66a027ec/interaction/
Provide a value for the input parameter 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>
Answer to a User Interaction After Validating Input Parameters
The presentation of a user interaction might dene constraints for the values that you can pass to the input
parameters of the workow. When you answer to a user interaction, you can validate the values that you
pass to the input parameters against the constraints that are dened in the presentation of the user
interaction.
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 list of all user interaction objects by making a GET request at the URL that holds the
available user interaction objects, or by ltering only the waiting user interactions:
URL Description
https://orchestrator_host:port/vco/a
pi/catalog/System/UserInteraction
Holds the available user interaction objects in Orchestrator.
https://orchestrator_host:port/vco/a
pi/catalog/System/UserInteraction?
status=0
Filters only the waiting user interaction objects.
You receive a list of the available user interaction objects. User interactions that are waiting have an
aribute with name state and value waiting.
2 Make a GET request at the URL that holds the inventory item of the waiting user interaction that you
want to answer:
GET https://{orchestrator_host}:
{port}/vco/api/catalog/System/UserInteraction/{userInteractionID}/
The response body contains a link to the user interaction instance. The user interaction instance is
associated with a particular workow run.
Developing a Web Services Client for VMware vRealize Orchestrator
26 VMware, Inc.