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
Procedure
1 Retrieve the list of all user interaction objects by making a GET request at the URL that holds the
available user interaction objects, or by filtering only the waiting user interactions:
URL Description
https://vco
host:port/vco/api/catalog/System/U
serInteraction
Holds the available user interaction objects in Orchestrator.
https://vco
host:port/vco/api/catalog/System/U
serInteraction?status=0
Filters only the waiting user interaction objects.
You receive a list of the available user interaction objects. User interactions that are waiting have an
attribute with name state and value waiting.
2 Make a GET request at the URL that holds the inventory item of the waiting user interaction that you
want to answer:
GET https://{vcoHost}:{port}/vco/api/catalog/System/UserInteraction/{userInteractionID}/
The response body contains a link to the user interaction instance. The user interaction instance is
associated with a particular workflow run.
3 Make a GET request at the URL of the user interaction instance:
GET https://{vcoHost}:
{port}/vco/api/workflows/{workflowID}/executions/{executionID}/interaction/
In the response body, you find a down link to the presentation of the user interaction.
4 Make a GET request at the URL of the presentation of the user interaction:
GET https://{vcoHost}:
{port}/vco/api/workflows/{workflowID}/executions/{executionID}/interaction/presentation/
You receive the definition of the user interaction presentation in the response body.
5 In the presentation definition, check for constraints of the values that you can pass to the input
parameters.
6 Run the user interation presentation by making a POST request at the URL where the instances of the
presentation reside:
POST https://{vcoHost}:
{port}/vco/api/workflows/{workflowID}/executions/{executionID}/interaction/presentation/insta
nces/
7 In the request body, provide values for the input parameters in an execution-context element.
In the response body, you receive the instance of the user interaction presentation. If the values that you
passed to the input parameters are valid, you find a valid="true" attribute in the execution element. In
the out-parameters element, you find the valid values for the input parameters that you can use to
answer to the user interaction.
8 Answer to the user interaction by making a POST request at the URL where the user interaction instance
resides:
POST https://{vcoHost}:
{port}/vco/api/workflows/{workflowID}/executions/{executionID}/interaction/
9 In the request body, pass an execution-context context with the values for the input parameters.
You can use the same request body as the one for the POST request that you made at the URL for the
user interaction presentation.
Developing a Web Services Client for VMware vCenter Orchestrator
26 VMware, Inc.