Get Report Definition
Get a Report Definition by identifier
Request
URI
GET
https://{api_host}/suite-api/api/reportdefinitions/{id}
COPY
Path Parameters
string
id
Required
The Report Definition identifier
Responses
200
The ReportDefinition object
Returns
report-definition
of type(s)
application/json
"{\n \"id\" : \"53a4dc25-2e0d-4f3a-9c1f-f3aafa319968\",\n \"description\" : \"Stressed VMs Report\",\n \"subject\" : [ ],\n \"lastRunTime\" : 1744473856596,\n \"active\" : true,\n \"owner\" : \"admin\"\n}"
string
id
Required
Identifier of the Report Definition.
This is system generated and uniquely identifies a Report Definition in the system.
string
name
Required
Name of the Report Definition
string
description
Optional
Description of the Report Definition
array of
string
subject
Required
Subjects of the Report Definition
object
traversal-specs
Optional
Traversal Specs applicable for the Report Definition
integer As int64
As int64
creationTime
Required
Creation time of the Report Definition
integer As int64
As int64
lastRunTime
Optional
Last Run time of the Report Definition
boolean
active
Optional
Whether the Report Definition is Active or not.
string
owner
Optional
Owner of the Report Definition
array of
object
links
Optional
Represents a HTTP 'link' element.
It is implicit that all the link tags support http 'GET' method.
404
There is no Report Definition in the system for the specified identifier
Operation doesn't return any data structure
Code Samples
COPY
curl -H 'Authorization: <value>' https://{api_host}/suite-api/api/reportdefinitions/{id}