7.1

Operations with Workflows
The Orchestrator REST API provides Web services that you can use to perform various operations with
workows.
Find a Workflow and Retrieve Its Definition
To be able to perform any kind of operation with a workow, you must nd that workow in the
Orchestrator inventory and retrieve its denition. The denition lists the workow input and output
parameters, and contains links to the available workow runs, the workow presentation, and other objects.
Prerequisites
Verify that you have imported the sample workows 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 Find the inventory item of the workow.
n
If you have the full name of the workow or a key word from the name, make a GET request at the
URL of the Workow service by applying a lter:
GET https://{orchestrator_host}:{port}/vco/api/workflows?
conditions=name={workflowFullName}
GET https://{orchestrator_host}:{port}/vco/api/workflows?conditions=name~{keyWord}
n
Search for the workow through the Catalog or the Inventory service by making a GET request at
the URL that is an entry point for the workow inventory items:
GET https://{orchestrator_host}:{port}/vco/api/catalog/System/Workflow/
GET https://{orchestrator_host}:{port}/vco/api/inventory/System/Workflows/
2 Retrieve the inventory item of the workow by making a GET request at its URL:
GET https://{orchestrator_host}:{port}/vco/api/catalog/System/Workflow/{workflowID}/
3 Retrieve the denition of the workow by making a GET request at the URL of the denition:
GET https://{orchestrator_host}:{port}/vco/api/workflows/{workflowID}/
Example: Search for the Send Hello Workflow
You can nd the Send Hello workow and retrieve its denition:
1 To nd the Send Hello workow, make a GET request at the URL of the Workow service by applying a
lter:
GET https://localhost:8281/vco/api/workflows?conditions=name~Hello
You receive a list of the workows that contain Hello in their names:
<xml version="1.0" encoding="UTF-8" standalone="yes">
<inventory-items xmlns="http://www.vmware.com/vco" total="2">
<link rel="down"
href="https://localhost:
8281/vco/api/catalog/System/Workflow/CF808080808080808080808080808080E6808080013086668236014a
0614d16e1/">
<attributes>
Developing a Web Services Client for VMware vRealize Orchestrator
16 VMware, Inc.