Get Report Schedules Using GET

Get Report Schedules Using GET

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

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

The Report Definition identifier

Query Parameters
integer
page
Optional

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

integer
pageSize
Optional

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
{
    "reportSchedules": [
        {
            "dayOfTheMonth": 0,
            "daysOfTheWeek": [
                "string"
            ],
            "emailAddresses": [
                "string"
            ],
            "emailBccAddresses": [
                "string"
            ],
            "emailCcAddresses": [
                "string"
            ],
            "emailPluginId": "string",
            "id": "string",
            "networkSharePluginId": "string",
            "recurrence": 0,
            "relativePath": [
                "string"
            ],
            "reportDefinitionId": "string",
            "reportScheduleType": "string",
            "resourceId": [
                "string"
            ],
            "startDate": "string",
            "startHour": 0,
            "startMinute": 0,
            "traversalSpec": {
                "adapterInstanceAssociation": false,
                "description": "string",
                "name": "string",
                "rootAdapterKindKey": "string",
                "rootResourceKindKey": "string"
            },
            "weekOfMonth": "string"
        }
    ]
}
reportSchedules
Optional

The Collection of Report schedules