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
workflowId
The ID of the workflow for which you
are checking a user's rights.
String
username
Orchestrator user name.
String
password
Orchestrator password.
Int
rights
n
a: The administrator can change
the rights of the object.
n
c: The user can edit the workflow.
n
I: The user can inspect the
workflow schema and scripting.
n
r: The user can view the workflow
(but not the schema or scripting).
n
x: The user can run the workflow.
NOTE User rights are not cumulative.
To perform all possible tasks on a
workflow, a user must have all of the
rights.
Return Value
Returns the following values:
n
True if the user has the specified rights on the workflow.
n
False if the user does not have the specified rights on the workflow.
The hasRights operation returns an "Unable to find workflow" exception if the workflow does not exist or
if the user calling hasRights does not have permission to view the workflow.
sendCustomEvent Operation
The sendCustomEvent operation synchronizes workflows with external events.
public void sendCustomEvent(String eventName, String serializedProperties);
The sendCustomEvent operation sends messages from Web service clients to workflows that are waiting for a
particular event to occur before they run. The waiting workflows resume their run when they receive the
message from sendCustomEvent.
A custom event that calls sendCustomEvent to send a message when it occurs can be any script, workflow, or
action that Orchestrator can run. For example, a workflow might use sendCustomEvent to trigger another
workflow that reloads all Orchestrator plug-ins when the sending workflow performs a specific action while
it is running.
The messages that sendCustomEvent sends are simple triggers, the format of which is not exposed to users.
The message triggers the waiting workflow to run at the moment that the server receives it.
IMPORTANT Access to the sendCustomEvent operation is not protected by a username and password
combination. VMware therefore recommends that you only use this function in secure, internal
deployments. For example, do not use this operation in deployments that operate openly across the Internet.
Chapter 5 Web Service API Operation Reference
VMware, Inc. 93