Developer Documentation
Get Reports
Released in v7.0.0Returns the location Reports.Location information for downloading the report for the specified file name. Retrieving a report involves two steps:
- Step 1: Invoke the Reports.get operation to provision a token and a URI.
- Step 2: Make an HTTP GET request by using the URI and the token returned in step 1 to retrieve the report.
The HTTP GET request will:
- Return 401 (Not Authorized) if the download URI is recognized, but the token is invalid, 404 if the URL is not recognized otherwise return 200 (OK)
- Provide the CSV contents as the output of the request. The API accepts the file name as input, reads the contents of that CSV file, and returns this text as the result of the API.
Request
URLURL
https://{api_host}/api/vcenter/lcm/reports/{report}
Path Parameters
Path Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | The parameter must be an identifier for the resource type: com.vmware.vcenter.lcm.report. |
Response
Response
Response BodyResponse Body
200 OK returns
ReportsLocation
of type application/json
{
"download_file_token": {
"expiry": "string",
"token": "string"
},
"uri": "string"
}| Property Name | Type | Description |
|---|---|---|
| download_file_token | ReportsToken |
Information about the token required in the HTTP GET request to retrieve the report |
| uri | string |
Report Download URI. |
Errors
| Code | Returns | Description |
|---|---|---|
| 401 | Error | com.vmware.vapi.std.errors.unauthenticated : if the user can not be authenticated. |
| 404 | Error | com.vmware.vapi.std.errors.not_found : If there is no file associated with report in the system. | com.vmware.vapi.std.errors.error : If there is some unknown internal error. The accompanying error message will give more details about the failure. |
| default | Error | Not available |
