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://localhost:
8281/vco/api/catalog/System/UserInteraction/888080808080808080808080808080805A808080013214533
8690643f66a027ec/interaction/
4 Make a GET request at the URL of the user interaction presentation:
GET https://localhost:
8281/vco/api/catalog/System/UserInteraction/888080808080808080808080808080805A808080013214533
8690643f66a027ec/interaction/presentation/
The presentation denes the input parameter as mandatory, and contains a constraint for the length of
the string that you can pass.
5 Make a POST request at the URL that holds the instances of the user interaction presentation:
POST https://localhost:
8281/vco/api/catalog/System/UserInteraction/888080808080808080808080808080805A808080013214533
8690643f66a027ec/interaction/presentation/instances/
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>
The execution element of the response body contains a valid="true" aribute, indicating that the input
parameter value is valid against the constraints in the user interaction presentation. The valid value is
listed in the output-parameters element:
............
<output-parameters>
<parameter name="name" type="string">
<string>John Smith</string>
</parameter>
</output-parameters>
............
6 Make a POST request at the URL of the user interaction instance by passing the same request body as in
the POST request in step 5.
POST https://localhost:
8281/vco/api/catalog/System/UserInteraction/888080808080808080808080808080805A808080013214533
8690643f66a027ec/interaction/
Cancel a Workflow Run
You can cancel the run of a workow by using the Orchestrator REST API.
Procedure
1 Retrieve the denition of the workow by making a GET request at the URL of the workow's denition:
GET https://{orchestrator_host}:{port}/vco/api/workflows/{workflowID}/
The workow denition contains a link to the available execution objects of the workow.
Developing a Web Services Client for VMware vRealize Orchestrator
28 VMware, Inc.