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 GET request at the URL of the resource that you want to export:
GET http://{orchestrator_host}:{port}/vco/api/resources/{resourceID}/
If the GET request is successful, you receive the status code 200. The content of the resource is available in the
response body.
Import a Configuration Element
You can import a conguration element by using the Orchestrator REST API.
Depending on the library of your REST client application, you can use custom code that denes the
properties of the conguration element.
Prerequisites
The conguration element binary content should be available as multi-part content. For details, see RFC
2387.
Procedure
1 In a REST client application, add request headers to dene the properties of the conguration element
that you want to import.
2 Make a POST request at the URL of the conguration element objects:
POST http://{orchestrator_host}:{port}/vco/api/configurations/
If the POST request is successful, you receive the status code 202.
Export a Configuration Element
You can export a conguration element by using the Orchestrator REST API.
Procedure
1 In a REST client application, add a request header with the following values.
n
Name: accept
n
Value: application/vcoobject+xml
2 Make a GET request at the URL of the conguration element that you want to export:
GET http://{orchestrator_host}:{port}/vco/api/configurations/{configuration_elementID}/
If the GET request is successful, you receive the status code 200. The conguration element content is
available in the response body.
Deleting Orchestrator Objects
The Orchestrator REST API provides Web services that you can use to delete workows, actions, packages,
resources, and conguration elements.
Delete a Workflow
You can delete a workow by using the Orchestrator REST API.
Procedure
1 Make a GET request and retrieve the ID of the workow from the list of returned workows:
GET http://{orchestrator_host}:{port}/vco/api/workflows/
Developing a Web Services Client for VMware vRealize Orchestrator
38 VMware, Inc.