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
Export a Workflow
You can export a workow by using the Orchestrator REST API and download the workow as a le.
Procedure
1 In a REST client application, add a request header with the following values.
n
Name: accept
n
Value: application/zip
2 Make a GET request at the URL of the workow that you want to export:
GET http://{orchestrator_host}:{port}/vco/api/workflows/{workflowID}/
If the GET request is successful, you receive the status code 200. The workow binary content is available as
an aachment with a default le name workflow_name.workflow. You can save the le with a REST client
application.
Import an Action
You can import an action 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 action.
Prerequisites
The action 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 action that you want to
import.
2 Make a POST request at the URL of the action objects:
POST http://{orchestrator_host}:{port}/vco/api/actions/
If the POST request is successful, you receive the status code 202.
Export an Action
You can export an action by using the Orchestrator REST API and download the action as a le.
Procedure
1 In a REST client application, add a request header with the following values.
n
Name: accept
n
Value: application/zip
2 Make a GET request at the URL of the action that you want to export:
GET http://{orchestrator_host}:{port}/vco/api/actions/{actionID}/
If the GET request is successful, you receive the status code 200. The action binary content is available as an
aachment with a default le name action_name.action. You can save the le with a REST client
application.
Chapter 3 Using the vRealize Orchestrator REST API
VMware, Inc. 35