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
Figure 3‑1. Process for Creating Orchestrator Web Service Applications
Create a VSOWebControl object
to connect to the Web service
HTTP
(Optional) check the connection to
the server using echoWorkflow
(Optional) check for plug-ins using
getAllPlugins
If necessary, find objects to execute workflows upon
Use find to locate an object of a
particular type, that matches a
particular query criterion
Use hasChildrenInRelation and
findRelation to find children of a
particular relation type
Use findForId to Iocate an object
with a particular ID number
Find a workflow
Use getAllWorkflows to list all
workflows
Use getWorkflowsForId to find a
workflow based on its unique ID
Use getWorkflowsWithName to
find workflows with a particular name
(Optional) check whether the current
user has rights to read, execute, or
edit the workflow using hasRights
HTTPS
Define the workflow's
inParameters
Execute the workflow using
executeWorkflow, which creates a
WorkflowToken
Perform different actions while the WorkflowToken executes
Provide runtime input
with
answerWorkflow
Input
Cancel the workflow
using
cancelWorkflow
Send a custom event
using
sendCustomEvent
When the WorkflowToken completes,
check the results with
getWorkflowTokenResult
Display, process, or otherwise act
upon the results of the workflow
Check the status of
the workflow with
getWorkFlowToken
Status
Find other
WorkflowToken
objects using
getWorkFlowToken
ForId
Follow the broad stages of development illustrated to create Orchestrator Web services client applications
that satisfy most of your requirements.
Developing a Web Services Client for VMware vCenter Orchestrator
54 VMware, Inc.