6.2
Table Of Contents
- Programming Guide
- Contents
- vRealize Automation Programming Guide
- Updated Information
- 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
- Requesting a Machine By Type
- Request a Machine
- Syntax for Listing Shared and Private Catalog Items
- Syntax for Finding a Catalog Item by Name
- Syntax for Locating the Blueprint Values Required to Construct a Machine Request
- Syntax for Constructing a JSON File For a Machine Request
- Syntax for Requesting a Machine
- Syntax for Viewing All of Your Requests
- Syntax for Finding a Resource by its Request ID
- Syntax for Viewing the Details of a Machine Request
- Request a vCloud Air Machine
- Request an Amazon Machine
- Request a Machine
- Approve a Machine Request
- List Provisioned Resources
- Reprovision a Machine Resource
- 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
- Create a Tenant
- Filtering and Formatting REST API Information
- Related Tools and Documentation
},
"isMultiValued": true
}]
}
Syntax for Displaying a Schema Definition for a vSphere Reservation
You can use the REST API reservation service to display a schema definition for a specific
vRealize Automation reservation type, for example a vSphere reservation.
Overview
Each reservation contains several fields. Some fields are common to all reservation types and some are
type-specific. The list of type-specific fields is defined in a schema. Call a data and schema service to get
schema definition information. The data and schema service combines fetch data and fetch schema
REST API calls.
Table 3‑6. Fields Common To All Reservation Types
Parameter Description Parameter Type
Id Specifies the reservation ID. GUID
name Specifies the reservation name. String
reservationTypeId Specifies the reservation type, for
example
Infrastructure.Reservation.Virtual.vSpher
e or
Infrastructure.Reservation.Virtual.Amazo
n.
String
tenantId Specifies the tenant ID that contains the
reservation.
String
subTenantId Specifies the subtenant ID that contains
the reservation.
GUID
enabled Specifies whether the reservation is
enabled.
Boolean
priority Specifies the priority of the reservation
during VM provisioning.
Integer
reservationPolicyId Specifies the reservation policy ID to
bind to this reservation.
GUID
alertPolicy Specifies the alert policy of the
reservation. The detail schema of this
field refers to the alert policy.
JSON
extensionData Contains type-specific fields. The detail
schema of this field is retrieved by the
data and schema service.
JSON
The following table describes the vSphere reservation types field IDs that appear in the output schema
definitions.
Programming Guide
VMware, Inc. 159