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
REST API Permissions
When you set permissions by using the Orchestrator REST API, you must use a set of characters to define
the permissions.
You can define the permissions for an element by including a sequence of characters in the <rights> tag of
the request body of a POST request .
The characters that you can use to set permissions through the Orchestrator REST API have specific
meanings.
Table 2‑1. Orchestrator REST API Permissions Character Set
Character Description
r
Gives view permissions.
x
Gives execute permissions.
i
Gives inspect permissions.
c
Gives edit permissions.
a
Gives administrative permissions.
Example: Syntax for Setting Permissions
You can use the following example syntax in the request body of a POST request at the URL of an
Orchestrator element's permissions.
<permissions xmlns="http://www.vmware.com/vco">
<permission>
<principal>cn=vcousers,ou=vco,dc=appliance</principal>
<rights>ric</rights>
</permission>
</permissions>
By setting ric permissions in the <rights> tag of the request body, you allow members of the vcousers user
group to view, inspect, and edit the Orchestrator element.
Retrieve the Permissions of a Workflow
You can retrieve information about the permissions of 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 GET request at the URL of the workflow's permissions:
GET http://{vcoHost}:{port}/vco/api/workflows/{workflowID}/permissions/
If the GET request is successful, you receive the status code 200. Information about the workflow's
permissions is available in the response body.
Developing a Web Services Client for VMware vCenter Orchestrator
40 VMware, Inc.