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
Parameter Description
URL hps://$host/reservation-service/api/reservations/types
Method Get
$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.
Output
The command output contains property names and values based on the command input parameters.
Property Description
Links Species an array of link objects, each of which contains the following parts:
rel Species the name of the link.
n
Self refers to the object that was returned or requested.
n
First, Previous, Next, and Last refer to corresponding pages of pageable lists.
n
Species the application or service that determines the other names.
href Species the URL that produces the result.
Content Species an array of data rows, each of which represents one of the objects returned in a
pageable list. Each object contains the following information:
@type
Contains the ReservationType string.
createdDate Species the create date.
lastUpdated Species the last update date.
version Displays the object version number.
Id Species the unique identier of this resource.
name Species the reservation type name.
description Species the reservation type description.
category Species the reservation category of Virtual, Cloud or Physical.
serviceTypeId Species the vRealize Automation service ID.
tenantId This contains a null value.
FormReference Species the user interface form reference. This eld is valid for user interface elements only.
n
type -- user interface form type
n
formId -- user interface form ID
SchemaClassId Species the schema class ID of the reservation type. Each supported reservation type contains
specic elds. The supported elds are dened in the schema. For details, see the reservation
service schema denitions in the vRealize Automation API Reference in the vRealize Automation
Documentation Center.
Programming Guide
118 VMware, Inc.