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
Using the vCenter Orchestrator REST
API 2
The Orchestrator REST API provides functionality that allows you to communicate with the Orchestrator
server directly through HTTP and perform various workflow-related operations over workflows.
The Orchestrator REST API exposes the objects from the inventories of the Orchestrator server and the
installed plug-ins as resources at predefined URLs. You make HTTP calls at these URLs to trigger
operations in Orchestrator. In this way, you can perform various tasks over workflows:
n
Run a workflow, schedule a workflow, retrieve the runs of a workflow, answer to a user interaction,
and cancel a workflow run.
n
Retrieve details about a workflow such as its input and output parameters and its presentation.
n
Retrieve details about a workflow run, such as its state, generated logs, start date, and end date.
n
Browse the inventories of Orchestrator and the installed plug-ins.
n
Import and export workflows, actions, and packages.
By using the Orchestrator REST API you can easily integrate Orchestrator workflows in custom applications
that you can build in any programing language.
The Orchestrator REST API also provides eTag support as well as a mechanism for caching of response data.
This chapter includes the following topics:
n
“Authenticating Against Orchestrator and Third-Party Systems,” on page 12
n
“Accessing the Reference Documentation for the Orchestrator REST API,” on page 14
n
“Using the Java REST SDK,” on page 14
n
“Operations with Workflows,” on page 15
n
“Working with Tasks,” on page 29
n
“Finding Objects in the Orchestrator Inventory,” on page 31
n
“Importing and Exporting Orchestrator Objects,” on page 33
n
“Deleting Orchestrator Objects,” on page 38
n
“Setting Permissions on Orchestrator Objects,” on page 39
n
“Performing Operations with Plug-Ins,” on page 45
n
“Performing Server Configuration Operations,” on page 47
n
“Performing Tagging Operations,” on page 48
VMware, Inc.
11