7.1
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
Filtering and Formatting REST
API Information 5
You can filter and format your vRealize Automation REST API command line and command line output.
You can use filters in your command line to limit JSON output to specific conditions. For example, you can
use a filter in a catalog item request to display only catalog items that contain a specific catalog ID. Or
you can use the requestID resource call to format the output of a command that displays request status.
You can also use an Odata equivalent to format that same information For details, see Syntax for Getting
Information for a Catalog Item.
Note You must URL encode all filter parameters when using Curl commands.
You can also reduce command line errors by using a JSON formatter to validate the JSON data and
present it in an easy-to-read format.
You can use command line options or JSON formatting tools, such as Open Data Protocol (OData), to
control the JSON results of your vRealize Automation REST API commands.
To simplify your JSON output, consider using command line options or a to filter out unnecessary data
and display only the information that you are interested in, such as the following information categories:
n
Published catalog items
n
Request status
n
Provisioned machine identifiers
For information about requesting a bearer token, and about available pagination, sorting, and filtering
options for any given command, see the Tips option on the vRealize Automation API landing page for the
selected service API.
VMware, Inc.
389