Get Report
Get the detail of a Report given its identifier
Request
URI
GET
https://{api_host}/suite-api/api/reports/{id}
COPY
Path Parameters
string
id
Required
The Identifier of the Report
Responses
200
The details of the Report
Returns
report
of type(s)
application/json
"{\n \"description\" : \"Cluster Capacity Risk Forecast Report\",\n \"subject\" : [ ],\n \"owner\" : \"admin\",\n \"completionTime\" : \"1 hour ago\",\n \"status\" : \"Completed\"\n}"
string
id
Optional
Identifier of the Report.
string
name
Optional
Name of the Report.
string
description
Optional
Description of the Report.
string As uuid
As uuid
resourceId
Required
Resource identifier for which the Report needs to be generated.
string As uuid
As uuid
reportDefinitionId
Required
Identifier of the Report Definition used to generate this Report.
object
traversalSpec
Optional
Represents traversal specs. These are templates in the system using which admins can assign specific set of resources to their users.
array of
string
subject
Optional
Subjects of the Report.
string
owner
Optional
Owner (user) who created/executed the Report Generation.
string
completionTime
Optional
Time when the Report Generation completed.
string
status
Optional
Status of Report Generation - whether the Report got generated successfully or not.
array of
object
links
Optional
Represents a HTTP 'link' element.
It is implicit that all the link tags support http 'GET' method.
Code Samples
COPY
curl -H 'Authorization: <value>' https://{api_host}/suite-api/api/reports/{id}