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 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://{vcoHost}:{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://{vcoHost}:{port}/vco/api/resources/
2 Make a DELETE request at the URL of the resource:
DELETE http://{vcoHost}:{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 configuration element by using the Orchestrator REST API.
Procedure
1 Make a GET request and retrieve the ID of the configuration element from the list of returned
configuration elements:
GET http://{vcoHost}:{port}/vco/api/configurations/
2 Make a DELETE request at the URL of the configuration element:
DELETE http://{vcoHost}:{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 define 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.
Chapter 2 Using the vCenter Orchestrator REST API
VMware, Inc. 39