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
Type Value Description
String
workflowTokenId
The identifier of the running workflow
to cancel
String
username
Orchestrator user name
String
password
Orchestrator password
Return Value
No return value. The cancelWorkflow operation returns an exception if you pass it an invalid parameter.
echo Operation
The echo operation tests the connection to the Web service by returning a String message.
The echo operation is declared as follows.
public String echo(String echo);
Type Value Description
String echo An arbitrary String. If the Web service
connection is working correctly, it
returns the String.
Return Value
Returns the same String as you provide as an input parameter.
echoWorkflow Operation
The echoWorkflow operation tests the connection to the Web service by checking serialization.
The echoWorkflow operation provides a useful debugging tool if you are connecting to an older Web service
implementation. Calling this operation verifies the connection to the server by checking that the serialize
and deserialize operations work correctly.
The echoWorkflow operation is declared as follows.
public Workflow echoWorkflow(Workflow workflow);
Type Value Description
Workflow
workflow The echoWorkflow operation takes a
Workflow object as a parameter. If the
connection and serialization are
working correctly, it returns the same
workflow.
Return Value
Returns the same Workflow object as the object provided as an input parameter.
executeWorkflow Operation
The executeWorkflow operation runs a specified workflow.
The executeWorkflow takes an array of WorkflowTokenAttribute objects as input parameters, which provide
the specific attributes with which this particular workflow instance runs.
Chapter 5 Web Service API Operation Reference
VMware, Inc. 81