7.1

Using the vRealize Orchestrator
REST API 3
The Orchestrator REST API provides functionality that allows you to communicate with the Orchestrator
server directly through HTTP and perform various workow-related operations over workows.
The Orchestrator REST API exposes the objects from the inventories of the Orchestrator server and the
installed plug-ins as resources at predened URLs. You make HTTP calls at these URLs to trigger operations
in Orchestrator. In this way, you can perform various tasks over workows:
n
Run a workow, schedule a workow, retrieve the runs of a workow, answer to a user interaction, and
cancel a workow run.
n
Retrieve details about a workow such as its input and output parameters and its presentation.
n
Retrieve details about a workow run, such as its state, generated logs, start date, and end date.
n
Browse the inventories of Orchestrator and the installed plug-ins.
n
Import and export workows, actions, and packages.
By using the Orchestrator REST API you can easily integrate Orchestrator workows in custom applications
that you can build in any programing language.
The Orchestrator REST API also provides eTag support as well as a mechanism for caching of response data.
This chapter includes the following topics:
n
“Authenticating Against Orchestrator and Third-Party Systems,” on page 12
n
“Accessing the Reference Documentation for the Orchestrator REST API,” on page 14
n
“Using the Java REST SDK,” on page 14
n
“Operations with Workows,” on page 16
n
“Working with Tasks,” on page 29
n
“Finding Objects in the Orchestrator Inventory,” on page 32
n
“Importing and Exporting Orchestrator Objects,” on page 34
n
“Deleting Orchestrator Objects,” on page 38
n
“Seing Permissions on Orchestrator Objects,” on page 40
n
“Performing Operations with Plug-Ins,” on page 46
n
“Performing Server Conguration Operations,” on page 48
n
“Performing Tagging Operations,” on page 49
VMware, Inc.
11