Get Report Schedules By Id

Get Report Schedules By Id

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/chargeback/reportdefinitions/{id}/schedules
COPY
Path Parameters
string
id
Required

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

Returns chargeback-report-schedules of type(s) application/json
"{\n  \"reportSchedules\" : [ {\n    \"resourceIds\" : [ \"985de36b-fc28-481d-860d-f8b8080b5421\" ],\n    \"startDate\" : \"01/01/2015\",\n    \"reportScheduleType\" : \"MONTHLY\",\n    \"startHour\" : 8,\n    \"startMinute\" : 0,\n    \"recurrence\" : 1,\n    \"dayOfTheMonth\" : 1\n  } ]\n}"
array of object
reportSchedules
Optional

The Collection of Chargeback Report schedules


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/suite-api/api/chargeback/reportdefinitions/{id}/schedules