Get Report Using GET

Get Report Using GET

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 
{
    "completionTime": "string",
    "description": "string",
    "id": "string",
    "links": [
        {
            "description": "string",
            "href": "string",
            "name": "string",
            "rel": "string"
        }
    ],
    "name": "string",
    "owner": "string",
    "reportDefinitionId": "string",
    "resourceId": "string",
    "status": "string",
    "subject": [
        "string"
    ],
    "traversalSpec": {
        "adapterInstanceAssociation": false,
        "description": "string",
        "name": "string",
        "rootAdapterKindKey": "string",
        "rootResourceKindKey": "string"
    }
}
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 link
links
Optional

links

string
name
Optional

Name of the Report.

string
owner
Optional

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

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.

traversal-spec
traversalSpec
Optional

traversalSpec


On This Page
Reports Operations
POST
Create Report Schedule Using POST
POST
Create Report Using POST
DELETE
Delete Report Using DELETE
DELETE
Delete Schedule Using DELETE
GET
Download Report Using GET
GET
Get Report Definitions Using GET
GET
Get Report Definition Using GET
GET
Get Report Schedules Using GET
GET
Get Report Schedule Using GET
GET
Get Reports Using GET
GET
Get Report Using GET
PUT
Update Report Schedule Using PUT