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
n
organization:
Specifies the business group or tenant to which this item belongs.
n
tenantRef:
ID of the tenant.
n
tenantLabel:
Name of the tenant.
n
subtenantRef:
ID of the business group.
n
subtenantLabel:
Name of the business group.
n
requestorEntitlementId:
Contains the requestorEntitlement value.
n
preApprovalId:
Specifies the ID of the preApproval entity.
n
postApprovalId:
Specifies the ID of the approval generated for the post-provisioning workflow step.
n
dateCreated:
Specifies the date this item was created in catalog.
n
lastUpdatedDate:
Specifies the date this item was last updated in catalog.
n
dateSubmitted:
Specifies the date this request was first submitted.
n
dateApproved:
Specifies the date this request was approved.
n
dateCompleted:
Specifies the date this request was completed.
n
quote:
Contains a quote made by the provider defining the estimated cost(s) associated with the request
and/or any resources provisioned as a result.
n
requestCompletion:
Requests completion information.
n
requestData:
Requests a map of the provider-specific field-value pairs collected for this request.
n
retriesRemaning:
Specifies the number of attempts remaining to move this request from its current state to the next
state in the request workflow.
Some state transitions require calls to external services. These calls may fail due to transient errors
such as momentary network errors. In these cases, the catalog will retry the call a number of times
before failing.
Programming Guide
VMware, Inc. 50