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
Set the Permissions for a Configuration Element
You can set the permissions for a conguration element by using the Orchestrator REST API.
Prerequisites
Review the types of permissions that you can set and the syntax that you can use in the request body. See
“REST API Permissions,” on page 40.
Procedure
1 Make a GET request and retrieve the ID of the conguration element from the list of returned
conguration elements:
GET http://{orchestrator_host}:{port}/vco/api/configurations/
2 In a REST client application, add request headers to dene the properties of the conguration element
for which you want to set permissions.
3 In the request body, specify the permissions that you want to set.
4 Make a POST request at the URL of the conguration element's permissions:
POST http://{orchestrator_host}:
{port}/vco/api/configurations/{configuration_elementID}/permissions/
If the POST request is successful, you receive the status code 201. Information about the conguration
element's permissions is available in the response body.
Performing Operations with Plug-Ins
The Orchestrator REST API provides Web services that you can use to perform various operations with
plug-ins.
Retrieve Information About Plug-Ins
You can retrieve metadata information for all installed plug-ins by using the Orchestrator REST API.
Procedure
1 In a REST client application, add request headers to dene the properties of the plug-ins.
2 Make a GET request at the URL of the plug-in objects:
GET http://{orchestrator_host}:{port}/vco/api/plugins/
If the GET request is successful, you receive the status code 200.
Import a Plug-In
You can import a plug-in by using the Orchestrator REST API.
Depending on the library of your REST client application, you can use a custom code that denes the
properties of the plug-in.
Note You cannot import a plug-in if a plug-in with the same name is already installed.
Prerequisites
The plug-in binary content should be available as multi-part content. For details, see RFC 2387.
Developing a Web Services Client for VMware vRealize Orchestrator
46 VMware, Inc.