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
Developing a Web Services Client 2
VMware vRealize Orchestrator provides Web services APIs so that you can develop applications to access
workows through the Web. The main purpose of the Orchestrator Web services APIs is to allow you to
integrate Orchestrator workows in custom Web-based applications.
Orchestrator provides a Web services API that is based on a representational state transfer (REST) API. The
Orchestrator REST API exposes the objects in the Orchestrator inventory and the inventories of the installed
plug-ins as resources that you can access at predened URLs. HTTP requests at these URLs result in
triggering operations over workows. The Orchestrator REST API exposes inventory objects as resources
through a set of RESTful Web services that you can use to retrieve the denitions of workows, run
workows, check the status of the running workows, cancel workow runs, process waiting user
interactions, retrieve the presentation of workows, and so on.
VMware, Inc.
9