7.3
Table Of Contents
- Programming Guide
- Contents
- vRealize Automation Programming Guide
- Updated Information
- Overview of the vRealize Automation REST API
- REST API Authentication
- Creating a Tenant
- Prerequisites for Creating a Tenant
- Create a Tenant With Parameters Inline
- Create a Tenant With a JSON File
- Identity Service Examples for Creating 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
- Approving a Machine Request
- Listing Provisioned Resources
- Managing Provisioned Deployments
- Working with Reservations
- Prerequisites for 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
- Service Examples for Working with Reservations
- Syntax for Displaying a List of Reservations
- Syntax for Displaying a Schema Definition for a vSphere Reservation
- Syntax for Displaying a Schema Definition for an Amazon Reservation
- Syntax for Displaying a Schema Definition for a vCloud Air Reservation
- Syntax for Getting the Business Group ID for a Reservation
- Syntax for Getting a Compute Resource for a Reservation
- Syntax for Getting Resources Schema for a vSphere Reservation
- Syntax for Getting Resources Schema for an Amazon Reservation
- Syntax for Getting Resources Schema for a vCloud Air Reservation
- Syntax for Creating a vSphere Reservation
- Syntax for Creating an Amazon Reservation
- Syntax for Creating a vCloud Air Reservation
- Syntax for Verifying a Reservation and Getting Reservation Details
- Syntax for Displaying a List of Supported Reservation Types
- Syntax for Updating a Reservation
- Syntax for Deleting a Reservation
- Working with Reservation Policies
- Working with Key Pairs
- Working with Network Profiles
- Getting a List of Available IP Ranges
- Importing and Exporting Content
- Understanding Blueprint Schema
- Prerequisites for Importing and Exporting Content
- List Supported Content Types Example
- List Available Content Example
- Filter Content by Content Type Example
- Create a Package for Export Example
- List Packages in the Content Service Example
- Export a Package Example
- Validate a Content Bundle Before Importing example
- Import a Package Example
- Export XaaS Content Example
- Import XaaS Content Example
- Related Tools and Documentation
- Filtering and Formatting REST API Information
},
{
"contentId": "DukesBankApplication",
"contentName": "DukesBankApplication",
"contentTypeId": "composite-blueprint",
"contentImportStatus": "SUCCESS",
"contentImportErrors": null
}
]
}
Input
You can use optional request parameters with your query URL to customize the returned content.
Table 13‑3. Package Validation Parameters
Name Description Type
file The name of the package file to be validated query
resolution mode The resolution mode to be used for performing validation when the
same entity exists in the system. Valid values are SKIP,
OVERWRITE. SKIP will not update the existing entity with the new
content while OVERWRITE will update the old entity with the new
data. In case the resolution mode is not explicitly provided the
default mode OVERWRITE will be used for conflict resolution.
query
Output
The package validation response body contains the following parameters.
Table 13‑4. Import and Export Response Body Parameters
Parameter Description
contentImportStatus Over all status of the import/validation operation, one failure in import/validation result guarantees failed
status. Values are as follows:
n
Success - Denotes the successful import or validation status at a particular component or package level.
n
Failed - Denotes an import or validation failure at a particular component package level.
n
Warning - Denotes a scenario that warrants a system level warning. Alerts the user about a possible
error condition that the proposed action may create.
contentImportResult
s
Set of collected content import/validation results populated by the provider. The Content import operation
result collection is the set of content that passed or failed. If failed the errors are populated in
ContentImportError. Properties are as follows:
n
contentId - (string) Unique content ID within the file system.
n
contentName - (anyType) Name of the content being imported.
n
contentTypeId - (string) The ID for the content type being exported. This matches the folder structure in
the exported zip.
n
contentImportStatus - Track the failed or succeeded status of an entity.
n
messages - Information returned by the provider.
n
contentImportErrors - Set of errors returned by the provider.
Programming Guide
VMware, Inc. 362