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
2 Make a DELETE request at the URL of the resource:
DELETE http://{orchestrator_host}:{port}/vco/api/resources/{resourceID}/
If the DELETE request is successful, you receive the status code 200, and the response body is empty.
Delete a Configuration Element
You can delete a conguration element by using the Orchestrator REST API.
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 Make a DELETE request at the URL of the conguration element:
DELETE http://{orchestrator_host}:{port}/vco/api/configurations/{configuration_elementID}/
If the DELETE request is successful, you receive the status code 200, and the response body is empty.
Setting Permissions on Orchestrator Objects
You can set custom permissions for an Orchestrator object by using the REST API. To set the permissions,
you must make a POST request at the URL of the object's permissions and dene the permissions in the
request body.
You can also use the Orchestrator REST API to retrieve information about an object's permissions or delete
the existing permissions.
REST API Permissions
When you set permissions by using the Orchestrator REST API, you must use a set of characters to dene
the permissions.
You can dene the permissions for an element by including a sequence of characters in the <rights> tag of
the request body of a POST request .
The characters that you can use to set permissions through the Orchestrator REST API have specic
meanings.
Table 3‑1. Orchestrator REST API Permissions Character Set
Character Description
r
Gives view permissions.
x
Gives execute permissions.
i
Gives inspect permissions.
c
Gives edit permissions.
a
Gives administrative permissions.
Developing a Web Services Client for VMware vRealize Orchestrator
40 VMware, Inc.