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
}, {
"key" : "provider-arrivalDate",
"value" : {
"type" : "dateTime",
"value" : "2014-02-21T19:44:00.000Z"
}
}, {
"key" : "provider-address",
"value" : {
"type" : "string",
"value" : "25 McLaren Street\nNorth Sydney, NSW 2060\nAUS"
}
}, {
"key" : "provider-hotel",
"value" : {
"type" : "entityRef",
"componentId" : null,
"classId" : "hotel",
"id" : "8",
"label" : "Racecar Hotel"
}
}, {
"key" : "provider-location",
"value" : {
"type" : "entityRef",
"componentId" : null,
"classId" : "location",
"id" : "3",
"label" : "AUS-Sydney-Napier"
}
}, {
"key" : "provider-duration",
"value" : {
"type" : "integer",
"value" : 5
}
} ]
},
...
Syntax for Finding a Resource by its Request ID
You can use the REST API catalog service with a request ID to find its corresponding resource.
Input
Use the supported input parameters to control the command output.
Parameter Description
URL https://$host/catalog-service/api/consumer/resources?$filter=request/id+eq+
%27requestId%27
$host Specifies the host name and fully qualified domain name or IP address of the
vRealize Automation identity server.
Programming Guide
VMware, Inc. 53