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
Return Value
Returns a WorkflowInput object for a specific workflow input that corresponds to the provided workflow
input ID.
getWorkflowInputForWorkflowTokenId Operation
The getWorkflowInputForWorkflowTokenId operation retrieves the answer to a user interaction for a
workflowTokenId object.
The getWorkflowInputForWorkflowTokenId operation is declared as follows.
public WorkflowInput getWorkflowInputForWorkflowTokenId(String workflowTokenId, String username,
String password);
Type Value Description
String
workflowTokenId
ID of this run of the workflow.
String
username
Orchestrator user name.
String
password
Orchestrator password.
Return Value
Returns a WorkflowInput object for a specific workflow token that corresponds to the provided workflow
token ID.
getWorkflowsWithName Operation
The getWorkflowsWithName operation searches for workflows by their name.
The getWorkflowsWithName operation is declared as follows.
public Workflow[] getWorkflowsWithName(String workflowName, String username, String password);
If you know the name (or a part of the name) of a particular workflow, you can obtain this workflow by
calling getWorkflowsWithName. The getWorkflowsWithName operation returns an array of workflows, so it can
be used to find several workflows at one time.
IMPORTANT The getWorkflowsWithName operation is a convenient means of obtaining workflows, but you
should not use it in production applications because workflow names can change. Use the getWorkflowForId
operation rather than the getWorkflowsWithName operation in production applications.
Type Value Description
String
workflowName
Name of the workflow to find.
The value of the workflowName
property can be a full name or a
wildcard (*), which returns all the
workflows available to the user. You
can also search for partial names. For
example, if you enter *Clone or
Clone* as the workflowName, this
returns all workflows with names that
contain the word Clone.
String
username
Orchestrator user name.
String
password
Orchestrator password.
Developing a Web Services Client for VMware vCenter Orchestrator
88 VMware, Inc.