Get Report Schedules

Get Report Schedules

The date and time values configured within the Report Schedule are converted to GMT time zone.

Request
URI
GET
https://{api_host}/suite-api/api/reportdefinitions/{id}/schedules
COPY
Path Parameters
string
id
Required

The Report Definition identifier

Query Parameters
boolean
includeResourcelessSchedules
Optional
Constraints: default: false

Flag to include schedules with not-existing resource

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 Report Schedules associated with the Report Definition identifier

Returns report-schedules of type(s) application/json 
"{\n  \"reportSchedules\" : [ {\n    \"reportDefinitionId\" : \"29553cc9-7415-4ef8-b0ae-c0c8ad3f31fa\",\n    \"resourceId\" : [ \"3827fbb9-93e5-4bfa-8784-80e0ad183ac6\" ],\n    \"startDate\" : \"01/01/2015\",\n    \"reportScheduleType\" : \"MONTHLY\",\n    \"startHour\" : 8,\n    \"startMinute\" : 0,\n    \"recurrence\" : 1,\n    \"dayOfTheMonth\" : 1,\n    \"emailAddresses\" : [ \"[email protected]\" ]\n  } ]\n}"
array of object
reportSchedules
Optional

The Collection of Report schedules


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/suite-api/api/reportdefinitions/{id}/schedules
On This Page
Reports Operations
GET
Get Report Schedules
PUT
Update Report Schedule
POST
Create Report Schedule
GET
Get Reports
POST
Create Report
GET
Get Report
DELETE
Delete Report
GET
Download Report
GET
Get Report Definitions
GET
Get Report Definition
GET
Get Report Schedule
DELETE
Delete Schedule