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
Property Description
This property defines the number of retries remaining for the current state transition. When it
reaches 0, the catalog will stop retrying and mark the request as failed. This property is reset to the
default number of retries for every new operation that is triggered.
n
requestedItemName
n
requestedItemDescription
Metadata Specifies the paging-related data:
n
Size:
Specifies the maximum number of rows per page.
n
totalElements:
Specifies the number of rows returned.
n
totalPages:
Specifies the total number of pages of data available.
n
Number:
Specifies the current page number.
n
Offset:
Specifies the number of rows skipped.
Example: curl Command
The following example command displays all requests.
curl --insecure -H "Content-Type: application/json" -H "Authorization: Bearer $token”
https://$host/catalog-service/api/consumer/requests
Example: JSON Output
The following JSON output is returned based on the command input.
{
"links" : [ ],
"content" : [ {
"@type" : "CatalogItemRequest",
"id" : "ec813a12-68c3-40a2-9a33-7efa38e8e2c9",
"iconId" : "Travel_100.png",
"version" : 5,
"requestNumber" : 1,
"state" : "SUCCESSFUL",
"description" : "Attending conference",
"reasons" : "Cuz I wanna go to Austrailia",
"requestedFor" : "tony@example.vmware.com",
"requestedBy" : "tony@example.vmware.com",
"organization" : {
"tenantRef" : "MYCOMPANY",
"tenantLabel" : "QETenant",
"subtenantRef" : "27b85c29-2624-459d-91d6-09ad071c6eb1",
"subtenantLabel" : "Finance"
},
"requestorEntitlementId" : "7840175e-08e8-4152-a3f9-c53a4dd10f38",
Programming Guide
VMware, Inc. 51