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
Property Object
A Property object represents a key-value pair that describes the properties of an item in the Orchestrator
inventory.
You can obtain a Property object by calling the getProperties operation on a FinderResult object, as the
following example shows.
Property[] props = finderResult.getProperties();
This example method call returns the contents of the FinderResult object's properties attribute.
The following table shows the properties of the Property object.
Type Value Description
String
name
Property name.
String
value
Property value.
The format of a property's values is
defined by each plug-in in its vso.xml
file, under the FinderResult
description.
QueryResult Object
The QueryResult object represents the results of a find query.
A QueryResult object contains an array of FinderResult objects and a counter. A QueryResult object is
returned by the find operation, as the following example shows.
public QueryResult find(String type, String query, String username,
String password);
The following table shows the properties of the QueryResult object.
Type Value Description
Long
totalCount
The total number of objects found.
The QueryResult object contains an
array of FinderResult objects. The
vso.xml file for the relevant plug-in
sets the number of FinderResult
objects the query returns. The standard
plug-ins that Orchestrator provides all
return an unlimited number of
FinderResult objects. The
totalCount property reports the total
number of FinderResult objects
found. If the value of totalCount is
greater than the number set by the
plug-in, the array of FinderResults
returned does not include all the
objects found in the queried inventory.
FinderResult[] elements An array of FinderResult objects.
Chapter 4 Web Service API Object Reference
VMware, Inc. 71