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
Id Specifies the unique identifier of this resource.
label Specifies the field label.
dataType Specifies the dataType field value:
n
type: Specifies the field value type:
n
Self refers to the object that was returned or requested.
n
First, Previous, Next, and Last refer to corresponding pages of a pageable list.
n
Specifies the application or service that determines the other names.
n
componentTypeid:
Specifies the type ID of the component.
n
component:
Specifies the unique identifier of the component.
n
classId:
Specifies the schema class of the field
This property is valid for complex and ref field types only.
n
label:
Specifies the label of the field data type.
displayAdvice Contains display advice for the field. This property is valid for a user interface element only.
permissibleValues Optional field. If this field is a permissible value list field, define the meta info for the permissible
value by using the following options:
n
type:
Specifies if the permissible value list is dynamic or static.
n
customAllowed:
Specifies if a custom value is allowed during user input in this field.
n
dependencies:
Specifies the list of fields that the current field depends on.
Programming Guide
VMware, Inc. 161