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
{
"type": "mandatory",
"value": {
"type": "constantClause",
"value": {
"type": "boolean",
"value": true
}
}
}
]
},
"isMultiValued": false
}
]
Syntax for Displaying a Schema Definition for an Amazon Reservation
You can use the REST API reservation service to display a schema denition for a specic
vRealize Automation reservation type, for example an Amazon reservation.
Overview
Each reservation contains several elds. Some elds are common to all reservation types and some are type-
specic. The list of type-specic elds is dened in a schema. Call a data and schema service to get schema
denition information. The data and schema service combines fetch data and fetch schema REST API calls.
Table 3‑10. Fields Common To All Reservation Types
Parameter Description Parameter Type
Id Species the reservation ID. GUID
name Species the reservation name. String
reservationTypeId Species the reservation type, for
example
Infrastructure.Reservation.Virtual.vS
phere or
Infrastructure.Reservation.Virtual.A
mazon.
String
tenantId Species the tenant ID that contains
the reservation.
String
subTenantId Species the subtenant ID that
contains the reservation.
GUID
enabled Species whether the reservation is
enabled.
Boolean
priority Species the priority of the
reservation during VM provisioning.
Integer
reservationPolicyId Species the reservation policy ID to
bind to this reservation.
GUID
alertPolicy Species the alert policy of the
reservation. The detail schema of this
eld refers to the alert policy.
JSON
extensionData Contains type-specic elds. The
detail schema of this eld is retrieved
by the data and schema service.
JSON
Chapter 3 REST API Use Cases
VMware, Inc. 147