get /ondemand/requests/all
Gets the list of all On-Demand requests.
Returns the list of statuses of all On-Demand requests. The list can be filtered by a particular app or report. The list 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 requests. Allowed field values are "name" and "created". Fields can be prefixed by "+" and "-" to indicate, respectively, ascending and descending order. Default is -created
Usage example: /requests?sort=+name,-created
- userId (optional)
- appId (optional)
- The ID of the app to filter on.
- reportId (optional)
- The ID of the report to filter on.
- tags (optional)
- sourceType (optional)
Return type
OnDemandRequestStatusListResponse
Example data
Content-Type: application/json
{
"data" : {
"totalItems" : 0,
"offset" : 6,
"limit" : 1,
"items" : [ {
"reportType" : "Excel",
"requestType" : "report",
"created" : "2000-01-23T04:56:07.000+00:00",
"id" : "00000000-0000-0000-0000-000000000000",
"title" : "title",
"outputFormat" : "pdf",
"status" : "queued"
}, {
"reportType" : "Excel",
"requestType" : "report",
"created" : "2000-01-23T04:56:07.000+00:00",
"id" : "00000000-0000-0000-0000-000000000000",
"title" : "title",
"outputFormat" : "pdf",
"status" : "queued"
} ]
}
}
Responses
- 200
- Success. A paginated list of request statuses is returned.
- 400
- The string of query parameters is malformed.