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
If the GET request is successful, you receive the status code 200. The configuration element content is
available in the response body.
Deleting Orchestrator Objects
The Orchestrator REST API provides Web services that you can use to delete workflows, actions, packages,
resources, and configuration elements.
Delete a Workflow
You can delete a workflow by using the Orchestrator REST API.
Procedure
1 Make a GET request and retrieve the ID of the workflow from the list of returned workflows:
GET http://{vcoHost}:{port}/vco/api/workflows/
2 Make a DELETE request at the URL of the workflow:
DELETE http://{vcoHost}:{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://{vcoHost}:{port}/vco/api/actions/
2 Make a DELETE request at the URL of the action:
DELETE http://{vcoHost}:{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://{vcoHost}:{port}/vco/api/packages/
Developing a Web Services Client for VMware vCenter Orchestrator
38 VMware, Inc.