get /reports
Gets the list of enabled and On-Demand enabled reports.
Returns the list of reports that the calling user is authorized to view.
The response includes the title and other details about each report. The list can be filtered by a particular app, and is sorted in the order specified by the sort parameter.
Query parameters
- offset (optional)
- The number of entries to skip. Default is 0.
- limit (optional)
- The maximum number of entries to return. Default is 50.
- sort (optional)
A comma separated list of fields to be used for sorting the reports. Allowed field values are "title" and "created". Fields can be prefixed by "+" and "-" to indicate, respectively, ascending and descending order. Default is -created.
Usage example: /reports?sort=+title,-created
- appId (optional)
- The ID of the app to filter on.
- docUrl (optional)
Return type
Example data
Content-Type: application/json
{
"data" : {
"totalItems" : 0,
"offset" : 6,
"limit" : 1,
"items" : [ {
"outputFormats" : [ "outputFormats", "outputFormats" ],
"created" : "2000-01-23T04:56:07.000+00:00",
"lastUpdate" : "2000-01-23T04:56:07.000+00:00",
"description" : "description",
"entityId" : "entityId",
"id" : "00000000-0000-0000-0000-000000000000",
"title" : "title",
"type" : "Excel"
}, {
"outputFormats" : [ "outputFormats", "outputFormats" ],
"created" : "2000-01-23T04:56:07.000+00:00",
"lastUpdate" : "2000-01-23T04:56:07.000+00:00",
"description" : "description",
"entityId" : "entityId",
"id" : "00000000-0000-0000-0000-000000000000",
"title" : "title",
"type" : "Excel"
} ]
}
}
Responses
- 200
- Success. A paginated list of reports is returned.
- 400
- Parameters of the query string are malformed.