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
Input Description
$schemaclassid Specifies the schema class ID.
This example illustrates how to use the resourcePool field of a vSphere reservation type as
an example. The schema class ID of a vSphere reservation is
Infrastructure.Reservation.Virtual.vSphere. For this example, the input value for
$schemaclassid is Infrastructure.Reservation.Virtual.vSphere.
$fieldId Specifies the field ID of the resource.
For example, the field ID for the resource pool is resourcePool. For this example, the input
value for $fieldId is resourcePool.
HTTP body Contains information about dependencies.
Because the dependency of this permissible value field is computeResource, you must
provide a dependency definition in the HTTP body.
Output
The command output contains property names and values based on the command input parameters.
Property Description
values An array of data rows, each of which represents one of the resource pool objects returned in a
pageable list. Each resource pool object contains an underlyingValue and label entry.
underlyingValue JSON string representing one permissible value for a field:
n
type -- data type of entityRef, complexRef, or primary
n
component ID -- componentID
n
classId -- schema class ID of current data type
n
id -- unique resource pool ID
n
label -- resource pool label
label Specifies the resource pool label. This value matches the underlyingValue value.
Example: curl Command
The following example command returns vSphere reservation storage information.
curl --insecure -H "Accept:application/json"
-H "Authorization: Bearer $token"
https://$host/reservation-service/api/data-service/schema/
Infrastructure.Reservation.Virtual.vSphere /default/ resourcePool /values -d “{
"text": "",
"dependencyValues": {
"entries": [{
"key": "computeResource",
"value": {
"type": "entityRef",
"componentId": null,
"classId": "ComputeResource",
"id": " cc254a84-95b8-434a-874d-bdfef8e8ad2c "
Programming Guide
VMware, Inc. 230