Get Report Definitions

Get Report Definitions

Get the Report Definitions based on the query specification specified

Request
URI
GET
https://{api_host}/suite-api/api/reportdefinitions
COPY
Query Parameters
string of array
name
Optional

Names of the Report Definitions

string of array
subject
Optional

Subjects of the Report Definitions

string of array
owner
Optional

Owners of the Report Definitions

integer
page
Optional
Constraints: default: 0

Page number from which data needs to be displayed (0-based)

integer
pageSize
Optional
Constraints: default: 1000

Expected number of entries per page


Authentication
This operation uses the following authentication methods.
Responses
200

The ReportDefinitions object that contains a list of ReportDefinition objects matching the query spec

Returns report-definitions of type(s) application/json
"{\n  \"reportDefinitions\" : [ {\n    \"id\" : \"acc73d0a-4829-4890-b964-ca0b47ff3ac6\",\n    \"description\" : \"Stressed VMs Report\",\n    \"subject\" : [ ],\n    \"lastRunTime\" : 1744473856590,\n    \"active\" : true,\n    \"owner\" : \"admin\"\n  } ]\n}"
object
pageInfo
Optional

Represents page information for a paged result

array of object
links
Optional

Collection of links

array of object
reportDefinitions
Optional

The Collection of Report Definitions


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/suite-api/api/reportdefinitions