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
Procedure
u
Make a DELETE request to remove private or global tags.
n
To remove a private tag, make a DELETE request at the URL of the object by using the following
syntax:
DELETE http://{vcoHost}:
{port}/vco/api/catalog/{namespace}/{objectType}/{objectId}/tag/{tag_name}
n
To remove a global tag, make a DELETE request at the URL of the object by using the following
syntax:
DELETE http://{vcoHost}:{port}/vco/api/catalog/{namespace}/{objectType}/{objectId}/tag/:
{tag_name}
If the DELETE request is successful, you receive the status code 200.
List Object Tags
You can retrieve a list of tags assigned to an object by using the Orchestrator REST API.
Procedure
u
Make a GET request at the URL of the object:
GET http://{vcoHost}:{port}/vco/api/catalog/{namespace}/{objectType}/{objectId}/tags
If the GET request is successful, you receive the status code 200.
List Tagged Objects by Type
You can use the Orchestrator REST API to retrieve a list of objects tagged with a specific tag and filter them
by object type.
Procedure
u
Make a GET request at the URL of the object type:
GET http://{vcoHost}:{port}/vco/api/catalog/{namespace}/{objectType}/?
tags=tag1&tags=:tag2=value
If the GET request is successful, you receive the status code 200.
List Tag Owners
You can retrieve a list of tag owners by using the Orchestrator REST API. Tag owners are users who have
created at least one tag.
Procedure
u
Make a GET request at the following URL:
GET http://{vcoHost}:{port}/vco/api/tags
If the GET request is successful, you receive the status code 200. The list that you retrieve contains users who
have created at least one tag. Global tags are listed under the system user name __GLOBAL__.
Chapter 2 Using the vCenter Orchestrator REST API
VMware, Inc. 49