7.2
Table Of Contents
- Programming Guide
- Contents
- vRealize Automation Programming Guide
- Overview of the vRealize Automation REST API
- REST API Authentication
- REST API Use Cases
- Create a Tenant
- Syntax for Displaying Your Current Tenants
- Syntax for Requesting a New Tenant
- Syntax for Listing All Tenant Identity Stores
- Syntax for Linking an Identity Store to the Tenant
- Syntax for Searching LDAP or Active Directory for a User
- Syntax for Assigning a User to a Role
- Syntax for Displaying all Roles Assigned to a User
- Request a Machine
- Approve a Machine Request
- List Provisioned Resources
- Manage Provisioned Deployments
- Working with Reservations
- Create a Reservation
- Display a List of Supported Reservation Types
- Displaying a Schema Definition for a Reservation
- Get the Business Group ID for a Reservation
- Get a Compute Resource for the Reservation
- Getting a Resources Schema by Reservation Type
- Creating a Reservation By Type
- Verify a Reservation and Get Reservation Details
- Display a List of Reservations
- Update a Reservation
- Delete a Reservation
- Create a Reservation
- Working with Reservation Policies
- Working with Key Pairs
- Working with Network Profiles
- Get a List of Available IP Ranges for an IPAM Provider
- Import and Export Content
- Syntax for Listing Supported Content Types
- Syntax for Listing Available Content
- Syntax for Filtering Content by Content Type
- Syntax for Creating a Package for Export
- Syntax for Listing Packages in the Content Service
- Syntax for Exporting a Package
- Syntax for Validating a Content Bundle Before Importing
- Syntax for Importing a Package
- Understanding Blueprint Schema
- Manage XaaS Content with Import and Export
- Create a Tenant
- Related Tools and Documentation
- Filtering and Formatting REST API Information
- Index
6 (Optional) View the details of your request.
You can perform a GET on the URI in the Location header to retrieve the updated request details.
curl --insecure -H "Content-Type: application/json"
-H "Authorization: Bearer $token” https://$host/catalog-
service/api/consumer/requests/7aaf9baf-aa4e-47c4-997b-edd7c7983a5b
Accept: application/json
The status information is particularly noteworthy in the request details. The phase eld corresponds to
the status that is displayed in the Requests tab in the user interface.
Syntax for Listing Shared and Private Catalog Items
You can use the REST API catalog service to retrieve a list of all shared viewable catalog items for the current
user. Shared catalog items do not belong to a specic business group. Also, this service retrieves a list of all
shared and private catalog items that can be viewed, including their business groups.
Input
Use the supported input parameters to control the command output.
Parameter Description
URL hps://$host/catalog-service/api/consumer/catalogItems
$host Species the host name and fully qualied domain name or IP address of the
vRealize Automation identity server.
$token Species a valid HTTP bearer token with necessary credentials.
page number The page number. Default is 1.
limit The number of entries per page. The default is 20.
$orderby Multiple comma-separated properties sorted in ascending or descending order. Valid
OData properties include the following:
n
name - lter based on catalog item name.
n
status - lter based on catalog item status.
n
service/id - lter based on catalog item service id.
n
service/name - lter based on catalog item service name.
n
organization/subTenant/id - lter based on catalog item business group ID, which
you can nd in the catalogItem payload under organization > subtenantRef
n
organization/subTenant/name - lter based on catalog item business group name,
which you can nd in catalogItem payload under organization
>subtenantLabel
n
outputResourceType/id - lter based on catalog item output resource type ID, for
example : Infrastructure.Virtual
n
outputResourceType/name - Filter based on catalog item output resource type
name, for example: "VirtualMavhine".
n
catalogItemType/id - lter based on catalog item type ID, for example:
"Infrastructure.Virtual".
n
catalogItemType/name - lter based on catalog item type name, for example:
"VirtualMachine".
n
icon/id - lter based on catalog item icon ID.
$top Sets the number of returned entries from the top of the response
$skip Sets the number of entries to skip.
Chapter 3 REST API Use Cases
VMware, Inc. 35