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
"totalPages": 1,
"number": 1,
"offset": 0
}
}
Syntax for Getting a Template Request for a Catalog Item
You can use the REST API catalog service to request catalog items. VMware supplies a number of templates
to help you create dierent types of machine requests.
Overview
In the entitledCatalogItemViews response, there is a link eld that contains a value similar to the following:
{
"@type":"link",
"href":"https://$host/catalog-
service/api/consumer/entitledCatalogItems/dc808d12-3786-4f7c-b5a1-
d5f997c8ad66/requests/template",
"rel":"GET: Request Template"
}
This URL is a HATEOAS link for a template request for this catalog item. The rel eld provides a
description of the link (request template) and indicates the HTTP method to use with the URI in the href
eld (GET). By using these HATEOAS links, you can make follow-on API calls without having to consult the
API documentation for the URI syntax or construct the links programmatically.
Review and Edit the Template Request
The returned template request is specic to the applicable catalog item. The elds and default values are
populated based on the conguration of the underlying blueprint.
You can review the contents of the template and optionally edit the values if you want to change them from
the default prior to submiing the request. For example, you can specify a value for the description eld or
change the values for the machine resources if the blueprint allows for a range.
Input
Use the supported input parameters to control the command output.
Parameter Description
id The UUID of the catalog item.
Output
The command output contains property names and values based on the command input parameters.
Property Description
entitledOrganizations The list of organizations in which the current user can consume the catalog item.
catalogItemId Species the catalog item identier.
Chapter 3 REST API Use Cases
VMware, Inc. 41