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
Table 3‑3. Inputs for Viewing the Available Actions for a Provisioned Machine
Parameter Description
URL https://$host/catalog-service/api/consumer/requests/$requestId
$host Specifies the host name and fully qualified domain name or IP address of the
vRealize Automation identity server.
$token Specifies a valid HTTP bearer token with necessary credentials.
$resourceId Specifies the resource ID for the request.
Output
The command output contains property names and values based on the command input parameters.
Table 3‑4. Outputs for Viewing the Available Actions for a Provisioned Machine
Property Description
type Specifies the operation type. The property type is
resourceOperationType.
id Specifies the identifier for the resource operation. The property
type is string.
extensionId Specifies the unique ID of the UI extension that is associated
with the operation if #getType() is set to
ResourceOperationType#EXTENSION.
providerTypeId Specifies the ID type for providers that support the action if
#getType() is set to ResourceOperationType#ACTION. The
property type is string.
bindingId Specifies the unique ID of the action that the external provider
that published it recognizes if #getType() is set to
ResourceOperationType#ACTION. The property type is string.
hasForm Indicates if the action has a request form to complete if
#getType() is set to ResourceOperationType#ACTION. The
property type is Boolean.
formScale Specifies the form scale value of the request form for the action,
if applicable. The property type is formScale.
Example: curl Command
The following example command displays the available actions for a provisioned machine by using its
resource ID.
curl --insecure -H "Content-Type: application/json"
-H "Authorization: Bearer $token”
https://$host/catalog-service/api/consumer/resources/resourceID/actions
Programming Guide
VMware, Inc. 128