Get Report

Get Report
Get the detail of a Report given its identifier

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

Authentication
This operation uses the following authentication methods.
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  \"publish\" : false\n}"
string
completionTime
Optional

Time when the Report Generation completed.

string
description
Optional

Description of the Report.

string
id
Optional

Identifier of the Report.

array of object
links
Optional

Represents a HTTP 'link' element.
It is implicit that all the link tags support http 'GET' method.

string
name
Optional

Name of the Report.

string
owner
Optional

Owner (user) who created/executed the Report Generation.

boolean
publish
Optional

Whether the tenant report needs to be published for tenants.

string As uuid As uuid
reportDefinitionId
Required

Identifier of the Report Definition used to generate this Report.

string As uuid As uuid
resourceId
Required

Resource identifier for which the Report needs to be generated.

string
status
Optional

Status of Report Generation - whether the Report got generated successfully or not.

array of string
subject
Optional

Subjects of the 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.


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/suite-api/api/reports/{id}
On This Page
Reports Operations
GET
Get Report Definitions
GET
Get Report Definition
GET
Get Report Schedules
POST
Create Report Schedule
PUT
Update Report Schedule
DELETE
Delete Schedule
GET
Get Report Schedule
GET
Get Reports
POST
Create Report
DELETE
Delete Report
GET
Get Report
GET
Download Report