Get Reports

Get Reports

If the query spec is not provided, all Reports present in the system are returned.

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

Reports name with which the filtering can be done

string of array
subject
Optional

Subjects with which the filtering can be done

string of array
status
Optional

Status of the report

string of array
resourceId
Optional

Resources on which the reports are generated

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 Collection of Reports matching the specified search critiera

Returns reports of type(s) application/json
"{\n  \"reports\" : [ {\n    \"description\" : \"Cluster Capacity Risk Forecast Report\",\n    \"subject\" : [ ],\n    \"owner\" : \"admin\",\n    \"status\" : \"Completed\"\n  } ]\n}"
object
pageInfo
Optional

Represents page information for a paged result

array of object
links
Optional

Collection of links

array of object
reports
Optional

Collection of reports


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