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
List Tags by Users
You can use the Orchestrator REST API to retrieve a list of tags created by a specic user.
You can also retrieve global tags. Global tags are listed under the system user name __GLOBAL__.
Procedure
u
Make a GET request at the URL of the user.
n
To retrieve a list of the tags created by a specic user, make a GET request by using the following
syntax:
GET http://{orchestrator_host}:{port}/vco/api/tags/{user_name}
n
To retrieve a list of global tags, make a GET request by using the following syntax:
GET http://{orchestrator_host}:{port}/vco/api/tags/__GLOBAL__
If the GET request is successful, you receive the status code 200.
List Tags by Users Filtered by Tag Name
You can use the Orchestrator REST API to retrieve a list of tag instances created by a specic user and lter
the tags by tag name.
You can also retrieve global tag instances. Global tags are listed under the system user name __GLOBAL__.
Procedure
u
Make a GET request at the URL of the user.
n
To retrieve a ltered list of the tag instances created by a specic user, make a GET request by using
the following syntax:
GET http://{orchestrator_host}:{port}/vco/api/tags/{user_name}/{tag_name}
n
To retrieve a ltered list of global tag instances, make a GET request by using the following syntax:
GET http://{orchestrator_host}:{port}/vco/api/tags/__GLOBAL__/{tag_name}
If the GET request is successful, you receive the status code 200. The information that you retrieve contains a
reference to the tagged object, tag name, tag value, and an indication whether the tag instance is global or
private.
Remove Tags by Users
You can use the Orchestrator REST API to remove all tags created by a specic user.
You can also remove global tags. Global tags are listed under the system user name __GLOBAL__.
Note To remove global tags, you must be logged in as a user with administrative privileges.
Procedure
u
Make a DELETE request at the URL of the user.
n
To remove the tags created by a specic user, make a DELETE request by using the following syntax:
DELETE http://{orchestrator_host}:{port}/vco/api/tags/{user_name}
n
To remove the global tags, make a DELETE request by using the following syntax:
DELETE http://{orchestrator_host}:{port}/vco/api/tags/__GLOBAL__
Chapter 3 Using the vRealize Orchestrator REST API
VMware, Inc. 51