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
Finding Objects in the Orchestrator Inventory
You can nd any object in the Orchestrator inventory by using the Catalog or the Inventory services. You
can access only a certain subset of objects by applying lter parameters at the end of the URLs where you
make HTTP requets.
You can use the Catalog service to nd objects in the Orchestrator inventory that are of a certain type, or
retrieve a specic object by its type and ID. For example, you can retrieve all objects that are of type
workflow or action, or can retrieve a specic workow or action.
The Inventory service allows you to browse the Orchestrator inventory by parent-child relations. Using the
Inventory service, you can access objects that are available at a specic location in the Orchestrator
inventory. For example, you can retrieve all workows for Datacenter management by browsing to their
location in the Orchestrator inventory, that is Library/vCenter/Datacenter.
Every service from the Orchestrator REST API supports lter parameters that you can add at the end of
URLs when making HTTP requests. Using the lter parameters, you can narrow the results that you receive
in the response body of a request at a specic URL.
Find Objects by Type and ID
You can use the Catalog service of the REST API to nd objects in Orchestrator by type and ID.
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 Make a GET request at the URL of the Catalog Service:
GET https://{orchestrator_host}:{port}/vco/api/catalog/
The response body of the request contains down links to the catalog entry points of the plug-ins that
expose inventories in Orchestrator as well as to the system objects in Orchestrator:
n
https://{orchestrator_host}:{port}/vco/api/catalog/{plug-in namespace}/
n
https://{orchestrator_host}:{port}/vco/api/catalog/System/
2 To access objects that a plug-in exposes or the system objects in Orchestrator, make a GET request at the
URL of the catalog entry point for the plug-in or at the URL where the system objects in Orchestrator
reside.
The response body of the request contains links to the types of objects that are exposed.
3 Make a GET request at the URL of the type of object that you want to access.
GET https://{orchestrator_host}:{port}/vco/api/catalog/{namespace}/{objectType}/
4 Make a GET request at the URL of the specic object that you want to nd:
GET https://{orchestrator_host}:{port}/vco/api/catalog/{namespace}/{objectType}/{objectID}/
Example: Find the Send Hello Workflow
You can nd the sample Send Hello workow by using the Catalog Service.
1 Make a GET request at the URL of the Catalog Service:
GET https://localhost:8281/vco/api/catalog/
Developing a Web Services Client for VMware vRealize Orchestrator
32 VMware, Inc.