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 an array of Workflow objects that correspond to the provided name or name fragment. Workflows
are returned in an array even if only one workflow is found. Returns null if you pass it an invalid parameter.
getWorkflowTokenBusinessState Operation
The getWorkflowTokenBusinessState operation retrieves the business state of a workflow token for a
workflowTokenId object.
Activities that are part of the workflow's schema can change the current business state of the workflow.
The getWorkflowTokenBusinessState operation is declared as follows.
public WorkflowToken getWorkflowTokenBusinessState(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 the business state of a WorkflowToken object for a specific workflow token that corresponds to the
provided workflow token ID.
getWorkflowTokenForId Operation
The getWorkflowTokenForId operation finds the WorkflowToken object for a specific workflow token ID.
The getWorkflowTokenForId operation is declared as follows.
public WorkflowToken getWorkflowTokenForId(String workflowTokenId, String username,
String password);
Individual threads or functions can run multiple workflows. The getWorkflowTokenForId operation allows a
central process or thread to track the progress of each workflow. Using getWorkflowTokenForId provides
access to all the information about a specific WorkflowToken because, although checking the token status only
requires the ID, it is often useful to obtain all the information about a given token.
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 WorkflowToken object for a specific workflow token that corresponds to the provided workflow
token ID.
Chapter 5 Web Service API Operation Reference
VMware, Inc. 89