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 workow:
DELETE http://{orchestrator_host}:{port}/vco/api/workflows/{workflowID}/
If the DELETE request is successful, you receive the status code 200, and the response body is empty.
Delete an Action
You can delete an action by using the Orchestrator REST API.
Procedure
1 Make a GET request and retrieve the ID of the action from the list of returned actions:
GET http://{orchestrator_host}:{port}/vco/api/actions/
2 Make a DELETE request at the URL of the action:
DELETE http://{orchestrator_host}:{port}/vco/api/actions/{actionID}/
If the DELETE request is successful, you receive the status code 200, and the response body is empty.
Delete a Package
You can delete a package by using the Orchestrator REST API.
When you delete a package, the elements from the package are not deleted. If you want to delete the content
of a package, you must provide an option parameter.
Procedure
1 Make a GET request and retrieve the name of the package from the list of returned packages:
GET http://{orchestrator_host}:{port}/vco/api/packages/
2 Make a DELETE request at the URL of the package, and if you want to delete elements from the package,
provide an option parameter at the end of the request:
DELETE http://{orchestrator_host}:{port}/vco/api/packages/{package_name}/?option={parameter}
Parameter Description
deletePackage
Only the package is deleted, while its content is retained.
deletePackageWithContent
The package and all its content is deleted. If other packages share elements
with the deleted package, the shared elements are deleted from the other
packages.
deletePackageKeepingShared
The package and the content that is not shared is deleted. Elements that are
shared with other packages are not deleted.
If you do not provide an option parameter, the default deletePackage parameter is used.
If the DELETE request is successful, you receive the status code 200, and the response body is empty.
Delete a Resource
You can delete a resource by using the Orchestrator REST API.
Procedure
1 Make a GET request and retrieve the ID of the resource from the list of returned resources:
GET http://{orchestrator_host}:{port}/vco/api/resources/
Chapter 3 Using the vRealize Orchestrator REST API
VMware, Inc. 39