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
parentType
Type of parent object. You can narrow
the search by specifying the parent
type, which limits the result to
children related by the given relation
to parents of a given parent type.
This value can be null, in which case
hasChildrenInRelation checks for
child objects related by the specified
relation type to all types of parent.
String
parentId
ID of a particular parent object.
Specifying the parentId allows you to
check for children related by a given
relation to a particular parent. This
check is useful if a particular parent
has large numbers of children that are
related to it by different relation types.
The findRelation operation returns
all of that parent's children, regardless
of the relation
type.hasChildrenInRelation checks
for the presence of only the children
related by the desired relation type.
This value can be null if you call
hasChildrenInRelation on the root
object of the hierarchy of objects.
String
relation
The type of relation by which children
are related to their parents.
Relation types are specified in the
vso.xml file for each plug-in.
String
username
Orchestrator user name.
String
password
Orchestrator password.
Return Value
Returns one of the following values:
1
Yes, children of the specified relation type are present
-1
No, children of the specified relation type are not present
0
Unknown, or an input parameter is invalid
Related Information
For more information, see “findRelation Operation,” on page 84.
hasRights Operation
The hasRights operation checks whether a user has permissions to view, edit, and run workflows.
To check the rights that you have on a workflow, you must have permission to view that workflow. If you
have only edit or run permission on a workflow, you cannot view what rights you have on this workflow,
and hasRights returns False.
A Web service application can check those rights by calling the hasRights operation. In the following
example, hasRights checks whether the user has the right to read the workflow.
hasRights(workflowId, username, password, 'r')
Developing a Web Services Client for VMware vCenter Orchestrator
92 VMware, Inc.