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
type
Type of object looked for.
String
id
ID of the object looked for.
String
username
Orchestrator user name.
String
password
Orchestrator password.
Return Value
Returns a FinderResult object containing details of the object found. Returns null if you pass it an invalid
parameter.
findRelation Operation
The findRelation operation finds all the children elements in an inventory that belong to a particular parent
or type of parent.
Knowing how a child is related to its parent is useful if you develop tree viewers to view the objects in a
library. The findRelation operation is declared as follows.
public FinderResult[] findRelation(String parentType, String parentId,
String relation, String username, String password);
Type Value Description
String
parentType
The type of parent object.
The parentType property can be the
name of a plug-in, or it can specify a
more narrowly defined parent. For
example, you can specify the
parentType as "VC:" to obtain the
objects at the root of VMware vCenter
Server plug-in, or you can a specific
folder, such as "VC:VmFolder".
String
parentId
The ID of a particular parent object.
The parentId parameter allows you
to find the children of a specific parent
object, if you know its ID.
String
relation
The name of the relation.
Calling findRelation returns all
children elements under a parent
identified by its parentId. If you omit
the parentId the parentType is not
the root type of the inventory, the
findRelation operation returns null.
See “Relation Types,” on page 84 for
more information.
String
username
Orchestrator user name.
String
password
Orchestrator password.
Relation Types
The relation property types are defined by the plug-ins. The validity of relations depends on the parent
type.
This table lists the relation types defined by each of the standard plug-ins provided by Orchestrator.
Developing a Web Services Client for VMware vCenter Orchestrator
84 VMware, Inc.