7.2
Table Of Contents
- Programming Guide
- Contents
- vRealize Automation Programming Guide
- 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
- Request a Machine
- Approve a Machine Request
- List Provisioned Resources
- Manage Provisioned Deployments
- 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
- Get a List of Available IP Ranges for an IPAM Provider
- Import and Export Content
- Syntax for Listing Supported Content Types
- Syntax for Listing Available Content
- Syntax for Filtering Content by Content Type
- Syntax for Creating a Package for Export
- Syntax for Listing Packages in the Content Service
- Syntax for Exporting a Package
- Syntax for Validating a Content Bundle Before Importing
- Syntax for Importing a Package
- Understanding Blueprint Schema
- Manage XaaS Content with Import and Export
- Create a Tenant
- Related Tools and Documentation
- Filtering and Formatting REST API Information
- Index
Parameter Description
URL hps://$host/catalog-service/api/consumer/requests/requestId
$host Species the host name and fully qualied domain name or IP address of
the vRealize Automation identity server.
$token Species a valid HTTP bearer token with necessary credentials.
catalogItemId The identier of a catalog item. Typically, this is provided by users via the
REST URI when making an entitledCatalogItem provisioning request.
requestedFor The user for whom this request is being made. Must be the fully qualied
user ID. Typically this is provided by the REST URI when making an
entitledCatalogItem provisioning request.
businessGroupId The business group identier associated with the request. Typically this is
provided via the REST URI when making the request.
description The catalog item description.
reasons
data Context-specic properties. Obtain the consumerEntitledCatalogItem
template request to identify the properties available for a given context.
Output
The command output contains property names and values based on the command input parameters.
Property Description
version Displays the object version number.
state Species the item state, such as submied.
approvalStatus Species a status indicating whether this request has been approved, rejected, or is still
pending some form of approval.
waitingStatus Species a status indicating whether this request is waiting on any external users or
services before it is able to progress.
requestNumber Species a more user-friendly identier for this request.
executionStatus Species the current execution status of the request.
stateName Species the localized state name.
phase Species the current phase of the request, which is more coarse grained and easier for
users to understand.
id Species the unique identier of this resource.
iconId Species an icon for this request based on the requested object type.
description Contains a brief description of this request.
reasons Species the business reasons entered by the requestor or owner of this request.
requestedFor Species the ID of the user for whom this request is logged.
requestedBy Species the ID of the user who actually submied the request
organization Subtenant and/or tenant owner of this request.
requestorEntitlementId Specied the value of the requestorEntitlement seing.
preApprovalId Species the ID of the preApproval seing.
postApprovalId Species the ID of the approval generated for the post-provisioning workow step.
dateCreated Species the date when this request was sent to the catalog.
lastUpdated Species the date when this request was last updated.
Chapter 3 REST API Use Cases
VMware, Inc. 45