5.5.1
Table Of Contents
- Developing a Web Services Client for VMware vCenter Orchestrator
- Contents
- Developing Web Services Client for VMware vCenter Orchestrator
- Developing a Web Services Client
- Using the vCenter 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
- Writing a Client Application for the Orchestrator SOAP Service
- Process for Creating an Orchestrator Web Service Client Application
- Web Service Endpoint
- Generating the Orchestrator Web Service Stubs
- Accessing the Server from Web Service Clients
- Create a Web Service Client
- Connect to the Orchestrator Web Service
- Find Objects in the Orchestrator Server
- Find Objects by Using the find Operation
- Find Objects by Using the findForId Operation
- Find Objects by Using the findRelation Operation
- Find Workflows in the Orchestrator Server
- Find Workflows by Using the getAllWorkflows Operation
- Retrieve the ID of a Workflow
- Find Workflows by Using the getWorkflowsWithName Operation
- Find Workflows by Using the getWorkflowForID Operation
- Run Workflows from a Web Service Client
- Interact with a Workflow While it Runs
- Obtain Workflow Results
- Time Zones and Running Workflows Through Web Services
- Web Service Application Examples
- Web Service API Object Reference
- Web Service API Operation Reference
- answerWorkflowInput Operation
- cancelWorkflow Operation
- echo Operation
- echoWorkflow Operation
- executeWorkflow Operation
- find Operation
- findForId Operation
- findRelation Operation
- getAllPlugins Operation
- getAllWorkflows Operation
- getWorkflowForId Operation
- getWorkflowInputForId Operation
- getWorkflowInputForWorkflowTokenId Operation
- getWorkflowsWithName Operation
- getWorkflowTokenBusinessState Operation
- getWorkflowTokenForId Operation
- getWorkflowTokenResult Operation
- getWorkflowTokenStatus Operation
- hasChildrenInRelation Operation
- hasRights Operation
- sendCustomEvent Operation
- simpleExecuteWorkflow Operation
- Index
2 Make a PUT request at the URL of the plug-in that you want to enable or disable:
PUT http://{vcoHost}:{port}/vco/api/plugins/{plug-in_name}/state/
If the PUT request is successful, you receive the status code 200.
Performing Server Configuration Operations
The Orchestrator REST API provides Web services that you can use to perform various operations related to
the Orchestrator server configuration.
Retrieve Information About the Orchestrator Server Configuration
You can retrieve information about the Orchestrator server configuration by using the Orchestrator REST
API.
Procedure
1 In a REST client application, add request headers to define the properties of the server for which you
want to retrieve information.
2 Make a GET request at the URL of the plug-in objects:
GET http://{vcoHost}:{port}/vco/api/server-configuration/
If the GET request is successful, you receive the status code 200.
Import Orchestrator Server Configuration
You can import a saved configuration by using the Orchestrator REST API.
Prerequisites
The configuration binary content should be available as multi-part content. For details, see RFC-2387.
Procedure
1 In a REST client application, add a request header with the following values.
n
Name: content-type
n
Value: multipart/form-data
2 Make a POST request at the URL of the server configuration:
POST http://{vcoHost}:{port}/vco/api/server-configuration/
If the POST request is successful, you receive the status code 200.
Export Orchestrator Server Configuration
You can export the server configuration by using the Orchestrator REST API.
Prerequisites
The configuration binary content should be available as multi-part content. For details, see RFC-2387.
Procedure
1 In a REST client application, add a request header with the following values.
n
Name: content-type
n
Value: multipart/form-data
Chapter 2 Using the vCenter Orchestrator REST API
VMware, Inc. 47