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
eventName The eventName property is the name
of the event that a workflow is waiting
for before running. The eventName
string you pass to sendCustomEvent
must match the name of an Event
object declared in the script, action or
workflow that defines the custom
event.
String
serializedProperties The serializedProperties property
defines the parameters to pass to the
waiting workflow as a series of name-
value pairs. The syntax of
serializedProperties is as follows:
"name1=value1\nname2=value2\nna
me3=value3"
If the workflow requires no input
parameters, the
serializedProperties property can
be null or omitted.
Return Value
No return value informs applications that the sendCustomEvent operation ran successfully.
The sendCustomEvent operation returns an exception if you pass it an invalid parameter.
Receiving Messages from sendCustomEvent
Workflows waiting for a message from sendCustomEvent before they run must declare the event they are
waiting for by calling the System.waitCustomEventUntil operation from the Orchestrator API. The following
example shows two calls to waitCustomEventUntil.
System.waitCustomEventUntil("internal", customEventKey, myDate);
System.waitCustomEventUntil("external", customEventKey, myDate);
The waitCustomEventUntil operation's parameters are as follows.
internal / external
The awaited event comes from another workflow (internal) or from a Web
service application (external).
customEventKey
The name of the awaited event.
myDate
The date until which waitCustomEventUntil waits for a message from
sendCustomEvent.
simpleExecuteWorkflow Operation
The simpleExecuteWorkflow operation uses string attributes to start a workflow.
IMPORTANT This operation is deprecated since Orchestrator 4.0. Do not use simpleExecuteWorkflow.
Type Value Description
String
workflowId
ID of the Workflow to be run.
String
username
Orchestrator user name.
Developing a Web Services Client for VMware vCenter Orchestrator
94 VMware, Inc.