7.1
Table Of Contents
- Developing a Web Services Client for VMware vRealize Orchestrator
- Contents
- Developing a Web Services Client for VMware vRealize Orchestrator
- Updated Information
- Developing a Web Services Client
- Using the vRealize 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
- Index
Contents
Developing a Web Services Client for VMware vRealize Orchestrator 5
1
Updated Information 7
2
Developing a Web Services Client 9
3
Using the vRealize Orchestrator REST API 11
Authenticating Against Orchestrator and Third-Party Systems 12
Using vCenter Single Sign-On Authentication with the Orchestrator REST API 12
Using LDAP Authentication with the Orchestrator REST API 14
Accessing the Reference Documentation for the Orchestrator REST API 14
Using the Java REST SDK 14
Operations with Workows 16
Find a Workow and Retrieve Its Denition 16
Run a Workow 18
Run a Workow After Validating Its Input Parameters Against the Workow Presentation 20
Interacting with a Workow While It Runs 23
Retrieve a Workow's Interactions 29
Access a Workow's Schema 29
Working with Tasks 29
Create a Task 29
Modify a Task 30
Check the State of a Task 31
Finding Objects in the Orchestrator Inventory 32
Find Objects by Type and ID 32
Find Objects by Relations 33
Apply Filters 34
Importing and Exporting Orchestrator Objects 34
Import a Workow 34
Export a Workow 35
Import an Action 35
Export an Action 35
Import a Package 36
Export a Package 36
Import a Resource 37
Export a Resource 37
Import a Conguration Element 38
Export a Conguration Element 38
Deleting Orchestrator Objects 38
Delete a Workow 38
Delete an Action 39
VMware, Inc.
3