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
Example: curl Command
The following example command displays details of a request.
curl --insecure -H "Content-Type: application/json" -H "Authorization: Bearer $token”
https://$host/catalog-service/api/consumer/requests/3a5d9697-e3c8-476f-9754-29e773af
Example: JSON Output
The following sample output contains information about the catalog item request 3a5d9697-
e3c8-476f-9754-29e773af4aa8.
{
"@type" : "CatalogItemRequest",
"id" : "3a5d9697-e3c8-476f-9754-29e773af4aa8",
"iconId" : "cafe_default_icon_genericCatalogItem",
"version" : 5,
"requestNumber" : 5,
"state" : "SUCCESSFUL",
"description" : "MYCOMPANY machine",
"reasons" : "New QE hire",
"requestedFor" : "fritz@example.mycompany.com",
"requestedBy" : "fritz@example.mycompany.com",
"organization" : {
"tenantRef" : "MYCOMPANY",
"tenantLabel" : "QETenant",
"subtenantRef" : "cccd7a7e-5283-416b-beb0-45eb4e924dcb",
"subtenantLabel" : "MyTestAgentBusinessGroup"
},
"requestorEntitlementId" : "1d896d03-96ad-4aae-9900-75f49b57a6bf",
"preApprovalId" : null,
"postApprovalId" : null,
"dateCreated" : "2014-09-19T20:58:35.854Z",
"lastUpdated" : "2014-09-19T20:59:14.014Z",
"dateSubmitted" : "2014-09-19T20:58:35.854Z",
"dateApproved" : null,
"dateCompleted" : "2014-09-19T20:59:13.994Z",
"quote" : null,
"requestCompletion" : {
"requestCompletionState" : "SUCCESSFUL",
"completionDetails" : "Request succeeded. Created tyler-prefix04."
},
"requestData" : {
"entries" : [ {
"key" : "provider-blueprintId",
"value" : {
"type" : "string",
"value" : "e16edcf9-6a10-4bc7-98e2-a33361aeb857"
}
}, {
"key" : "provider-Cafe.Shim.VirtualMachine.MaxCost",
"value" : {
"type" : "string",
"value" : "0.0000000000"
Programming Guide
VMware, Inc. 57