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
$lter Boolean expression for whether a particular entry should be included in the response.
Valid OData properties include the following:
n
name - lter based on catalog item name.
n
status - lter based on catalog item status.
n
service/id - lter based on catalog item service id.
n
service/name - lter based on catalog item service name.
n
organization/subTenant/id - lter based on catalog item business group ID, which
you can nd in the catalogItem payload under organization > subtenantRef
n
organization/subTenant/name - lter based on catalog item business group name,
which you can nd in catalogItem payload under organization
>subtenantLabel
n
outputResourceType/id - lter based on catalog item output resource type ID, for
example : Infrastructure.Virtual
n
outputResourceType/name - Filter based on catalog item output resource type
name, for example: "VirtualMavhine".
n
catalogItemType/id - lter based on catalog item type ID, for example:
"Infrastructure.Virtual".
n
catalogItemType/name - lter based on catalog item type name, for example:
"VirtualMachine".
n
icon/id - lter based on catalog item icon ID.
serviceId (Optional) Query parameter to lter the returned catalog items by one specic service.
onBehalfOf (Optional) Query parameter that provides the value of the user ID when making a
request on behalf of another user.
Output
The command output contains property names and values based on the command input parameters.
Property Description
outputResourceTypeRef Species the type of the resource that results from requesting the catalog item.
catalogItemId Species the catalog item identier.
name Species the user friendly name of the catalog item. Species the property type is
string.
description Species a short description of the catalog item. Species the property type is string.
catalogItemTypeRef Species the type of the catalog item.
serviceRef Species the catalog service that contains the catalog item.
iconId Species the associated icon representing this item.
isNoteworthy Species if the catalog item should be highlighted to users for a period of time.
dateCreated Species the date that this item was created in the catalog.
lastUpdatedDate Species the date that this item was last updated in the catalog.
entitledOrganizations The list of organizations in which the current user can consume the catalog item.
Example Curl Command
The following example command retrieves information about all the available shared catalog items of the
type ConsumerEntitledCatalogItemView.
curl --insecure -H "Content-Type: application/json"
-H "Authorization: Bearer $token” https://$host/catalog-
service/api/consumer/entitledCatalogItemViews
Chapter 3 REST API Use Cases
VMware, Inc. 39