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
"subtenantLabel" : "MyTestAgentBusinessGroup"
},
"providerBinding" : {
"bindingId" : "e16edcf9-6a10-4bc7-98e2-a33361aeb857",
"providerRef" : {
"id" : "c6fb1980-75b4-4adc-ac71-020d75f61978",
"label" : "iaas-service"
}
},
"forms" : null,
"callbacks" : null,
"isNoteworthy" : true,
"dateCreated" : "2014-02-14T21:53:39.072Z",
"lastUpdatedDate" : "2014-02-14T21:54:07.756Z",
"iconId" : "cafe_default_icon_genericCatalogItem",
"catalogItemTypeRef" : {
"id" : "Infrastructure.Virtual",
"label" : "Virtual Machine"
},
"serviceRef" : {
"id" : "e90847d7-03e1-45a9-8377-be77be03af6f",
"label" : "Tyler's Service"
},
"outputResourceTypeRef" : {
"id" : "Infrastructure.Virtual",
"label" : "Virtual Machine"
}
} ],
"metadata" : {
"size" : 20,
"totalElements" : 1,
"totalPages" : 1,
"number" : 1,
"offset" : 0
}
}
Syntax for Finding a Catalog Item by Name
You can use the REST API catalog service to locate a catalog item in the service catalog.
Input
Use the input parameters to control the command output.
Parameter Description
URL https://$host/catalog-service/api/consumer/entitledCatalogItems?$filter=name+eq+%27my
+custom+blueprint%27
$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.
$catalogItemId Specifies the ID of a catalog item.
Programming Guide
VMware, Inc. 38