5.5.1

Table Of Contents

Contents

Developing Web Services Client for VMware vCenter Orchestrator 7

Developing a Web Services Client 9

Using the vCenter 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 Workflows 15

Find a Workflow and Retrieve Its Definition 15

Run a Workflow 18

Run a Workflow After Validating Its Input Parameters Against the Workflow Presentation 19

Interacting with a Workflow While It Runs 23

Retrieve a Workflow's Interactions 28

Access a Workflow's Schema 28

Working with Tasks 29

Create a Task 29

Modify a Task 30

Check the State of a Task 30

Finding Objects in the Orchestrator Inventory 31

Find Objects by Type and ID 31

Find Objects by Relations 32

Apply Filters 33

Importing and Exporting Orchestrator Objects 33

Import a Workflow 33

Export a Workflow 34

Import an Action 34

Export an Action 35

Import a Package 35

Export a Package 36

Import a Resource 36

Export a Resource 37

Import a Configuration Element 37

Export a Configuration Element 37

Deleting Orchestrator Objects 38

Delete a Workflow 38

Delete an Action 38

Delete a Package 38

Delete a Resource 39

Delete a Configuration Element 39

VMware, Inc.