Get Reports
Returns the location Reports.Location information for downloading a compatibility report. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.HardwareCompatibility.Read.
Request
URLURL
https://{api_host}/api/esx/hcl/reports/{report}
Path Parameters
Path Parameters
string
report
Required
identifier of hardware compatiblity report to be downloaded. The parameter must be an identifier for the resource type: com.vmware.esx.hcl.resources.CompatibilityReport.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
HclReportsLocation
of type application/json
Reports.Location structure which includes the URI to file, short lived token and expiry of the token in the Reports.Location object.
{
"report_token": {
"expiry": "string",
"token": "string"
},
"url": "string"
}
report_token
Required
Information about the token required in the HTTP GET request to download the compatibility report.
string
url
Required
Compatibility report download URL.
Errors
500
com.vmware.vapi.std.errors.resource_inaccessible : if the vCenter this API is executed on is not part of the Customer Experience Improvement Program (CEIP). | com.vmware.vapi.std.errors.error : If there is some unknown error. The accompanying error message will give more details about the failure.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
Invoke-GetReportHcl -Report "MyReport"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/esx/hcl/reports/{report}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: get
