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 available execution instances of the workow by making a GET request at their URL:
GET https://{orchestrator_host}:{port}/vco/api/workflows/{workflowID}/executions/
The response body of the request lists the available execution instances of the workow where you can
view the start and end dates of every workow run as well their status and initiator.
3 (Optional) To get more details about a particular run of the workow, make a GET request at the URL of
that run:
GET https://{orchestrator_host}:
{port}/vco/api/workflows/{workflowID}/executions/{executionID}/
In the response body of the request, you receive the XML representation of the particular workow run.
You can check the values of the input parameters that are passed for this run, the user who initiated the
run, the start and end dates, as well as the state of the run.
4 (Optional) To retrieve the logs that are generated for the workow run, make a GET request at the URL
that holds the logs:
GET https://{orchestrator_host}:
{port}/vco/api/workflows/{workflowID}/executions/{executionID}/logs/
5 (Optional) To retrieve additional information about the state of the run, make a GET request at the URL
that holds the state of the workow:
GET https://{orchestrator_host}:
{port}/vco/api/workflows/{workflowID}/executions/{executionID}/state/
Example: Get the Runs of the Send Hello Workflow and Check the State of a Particular Run
If you have run the Send Hello workow, you can get the available execution objects and check details about
them.
1 Get the denition of the Send Hello workow by making a GET request at the URL that holds the
denition:
GET https://localhost:
8281/vco/api/workflows/CF808080808080808080808080808080DA808080013086668236014a0614d16e1/
2 Get the available runs of the workow by making a GET request at the URL that holds the execution
objects for the workow:
GET https://localhost:
8281/vco/api/workflows/CF808080808080808080808080808080DA808080013086668236014a0614d16e1/exec
utions/
3 From the response body of the request, select a workow run and make a GET request to retrieve it:
GET https://localhost:
8281/vco/api/workflows/CF808080808080808080808080808080DA808080013086668236014a0614d16e1/exec
utions/888080808080808080808080808080803A8080800132145338690643f66a027ec/
The response body contains the XML representation of the workow run with the specied ID, where
you can check details about that run:
.......
<input-parameters>
<parameter name="name" type="string">
<string>John Smith</string>
</parameter>
</input-parameters>
<output-parameters>
<parameter name="message" type="string">
Developing a Web Services Client for VMware vRealize Orchestrator
24 VMware, Inc.