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
n
completed: the workflow has finished
n
failed: the workflow encountered an error
n
suspended: the workflow run is paused
The getWorkflowTokenStatus operation is declared as follows.
public String[] getWorkflowTokenStatus(String[] workflowTokenID, String username,
String password);
Type Value Description
Array of strings
workflowTokenId
List of workflow token IDs.
String
username
Orchestrator user name.
String
password
Orchestrator password.
Return Value
Returns a list of workflow token status values. The returned value is a string array of the globalStatus of
each workflow token, ordered by their workflowTokenID values. Returns null if you pass it an invalid
parameter.
hasChildrenInRelation Operation
The hasChildrenInRelation operation checks whether a given relation type has any children.
In some cases, objects are most easily located through their relationships with other objects. You can obtain
all the objects that relate to another object by a given relation by calling the findRelation operation on that
object. The findRelation operation finds only the relatives of a known object. The hasChildrenInRelation
operation checks for the presence of objects that present a given relation property. hasChildrenInRelation
checks for the presence of objects that are children of other objects and are related to their parents by a given
relation type. For example, a snapshot of a virtual machine is a child of the original virtual machine.
Checking for all virtual machines that are children of other virtual machines enables you to identify all
snapshots.
Knowing how a child is related to its parent is useful if you develop tree viewers to view the objects in the
library. The hasChildrenInRelation operation is declared as follows.
public int hasChildrenInRelation(String parentType, String parentId, String relation, String
username, String password);
Chapter 5 Web Service API Operation Reference
VMware, Inc. 91