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
Delete the Permissions of a Workflow
You can delete the permissions of a workflow by using the Orchestrator REST API. You can delete the
existing permissions of a workflow before you set new permissions.
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's permissions:
DELETE http://{vcoHost}:{port}/vco/api/workflows/{workflowID}/permissions/
If the DELETE request is successful, you receive the status code 204, and the response body is empty.
Set the Permissions for a Workflow
You can set the permissions for a workflow by using the Orchestrator REST API.
Prerequisites
Review the types of permissions that you can set and the syntax that you can use in the request body. See
“REST API Permissions,” on page 40.
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 In a REST client application, add request headers to define the properties of the workflow for which
you want to set permissions.
3 In the request body, specify the permissions that you want to set.
4 Make a POST request at the URL of the workflow's permissions:
POST http://{vcoHost}:{port}/vco/api/workflows/{workflowID}/permissions/
If the POST request is successful, you receive the status code 201. Information about the workflow's
permissions is available in the response body.
Retrieve the Permissions of an Action
You can retrieve information about the permissions of 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 GET request at the URL of the action's permissions:
GET http://{vcoHost}:{port}/vco/api/actions/{actionID}/permissions/
If the GET request is successful, you receive the status code 200. Information about the action's permissions is
available in the response body.
Chapter 2 Using the vCenter Orchestrator REST API
VMware, Inc. 41