7.3
Table Of Contents
- Programming Guide
- Contents
- vRealize Automation Programming Guide
- Updated Information
- Overview of the vRealize Automation REST API
- REST API Authentication
- Creating a Tenant
- Prerequisites for Creating a Tenant
- Create a Tenant With Parameters Inline
- Create a Tenant With a JSON File
- Identity Service Examples for Creating 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
- Requesting a Machine
- Approving a Machine Request
- Listing Provisioned Resources
- Managing Provisioned Deployments
- Working with Reservations
- Prerequisites for 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
- Service Examples for Working with Reservations
- Syntax for Displaying a List of Reservations
- Syntax for Displaying a Schema Definition for a vSphere Reservation
- Syntax for Displaying a Schema Definition for an Amazon Reservation
- Syntax for Displaying a Schema Definition for a vCloud Air Reservation
- Syntax for Getting the Business Group ID for a Reservation
- Syntax for Getting a Compute Resource for a Reservation
- Syntax for Getting Resources Schema for a vSphere Reservation
- Syntax for Getting Resources Schema for an Amazon Reservation
- Syntax for Getting Resources Schema for a vCloud Air Reservation
- Syntax for Creating a vSphere Reservation
- Syntax for Creating an Amazon Reservation
- Syntax for Creating a vCloud Air Reservation
- Syntax for Verifying a Reservation and Getting Reservation Details
- Syntax for Displaying a List of Supported Reservation Types
- Syntax for Updating a Reservation
- Syntax for Deleting a Reservation
- Working with Reservation Policies
- Working with Key Pairs
- Working with Network Profiles
- Getting a List of Available IP Ranges
- Importing and Exporting Content
- Understanding Blueprint Schema
- Prerequisites for Importing and Exporting Content
- List Supported Content Types Example
- List Available Content Example
- Filter Content by Content Type Example
- Create a Package for Export Example
- List Packages in the Content Service Example
- Export a Package Example
- Validate a Content Bundle Before Importing example
- Import a Package Example
- Export XaaS Content Example
- Import XaaS Content Example
- Related Tools and Documentation
- Filtering and Formatting REST API Information
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. In
this example, the URI-in-Location-header is 7aaf9baf-aa4e-47c4-997b-edd7c7983a5b.
curl --insecure -H "Accept: application/json" -H "Content-Type: application/json" -H
"Authorization: Bearer $token" https://$vRA/catalog-service/api/consumer/requests/7aaf9baf-
aa4e-47c4-997b-edd7c7983a5b
For details regarding input and output for this request, see Syntax for Viewing Details of a Machine
Request.
Catalog Service Examples for Requesting a Machine
Syntax for each service example lists input parameters, output parameters, and curl commands.
n
Syntax for Listing Shared and Private Catalog Items
GET /api/consumer/entitledCatalogItemViews retrieves a list of all shared viewable catalog
items for the current user. Shared catalog items do not belong to a specific business group. This
service also retrieves a list of all shared and private catalog items that can be viewed, including their
business groups.
n
Syntax for Getting Information for a Catalog Item
GET /api/consumer/entitledCatalogItemViews/{id} gets information about a specific catalog
item.
n
Syntax for Getting a Template Request for a Catalog Item
GET /api/consumer/entitledCatalogItems/{id}/requests/template retrieves a template
request for a specific catalog item. VMware supplies a number of templates to help you create
different types of machine requests.
n
Syntax for Requesting a Machine
POST /api/consumer/entitledCatalogItems/{id}/requests submits a request for a specific
catalog item with input provided in a JSON file.
n
Syntax for Viewing Details of a Machine Request
GET /api/consumer/requests/{requestId} provides the details of a machine request, where
requestId is the URI in the Location header.
Syntax for Listing Shared and Private Catalog Items
GET /api/consumer/entitledCatalogItemViews retrieves a list of all shared viewable catalog items
for the current user. Shared catalog items do not belong to a specific business group. This service also
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.
Programming Guide
VMware, Inc. 44