|
API |
REQUEST |
PARAMETERS TO BE PASSED |
RESPONSE |
HELP LNK |
|
To create a schedule
|
POST:/api/v3.0/reports/schedule |
{"Name":"string",
"ReportId":"string",
"ExportType":"string",
"StartTime":"string",
"NeverEnd":true,
"EndAfterOccurrence":0,
"EndDate":"string",
"UserList":["string"],
"GroupList":[0],
"ExternalRecipientsList":["string"],
"ScheduleType":"string",
"HourlySchedule":{"ScheduleInterval":"string"},
"DailySchedule":{"RecurrenceType":"string","EveryNdays":0,"EveryWeekday":true},
"WeeklySchedule":{"RecurrenceWeeks":0,"RecurrenceDays":["string"]},
"MonthlySchedule":{"RecurrenceType":"string","DayRecurrence":{"DayInterval":0,"MonthInterval":0},"CustomRecurrence":{"WeekOfMonth":"string","DayOfWeek":"string","MonthInterval":0}},
"YearlySchedule":{"YearInterval":0,"RecurrenceType":"string","MonthRecurrence":{"MonthOfYear":"string","DayOfMonth":0},"CustomRecurrence":{"WeekOfMonth":"string","DayOfWeek":"string","MonthOfYear":"string"}}} |
Schedule created successfully. |
|
|
To update a schedule |
PUT:/api/v3.0/reports/schedule/{scheduleid} |
{"Name":"string",
"ReportId":"string",
"ExportType":"string",
"StartTime":"string",
"NeverEnd":true,
"EndAfterOccurrence":0,
"EndDate":"string",
"UserList":["string"],
"GroupList":[0],
"ExternalRecipientsList":["string"],
"RemoveUserList":["string"],
"RemoveGroupList":[0],
"RemoveExternalRecipientsList":["string"],
"ScheduleType":"string",
"HourlySchedule":{"ScheduleInterval":"string"},
"DailySchedule":{"RecurrenceType":"string","EveryNdays":0,"EveryWeekday":true},
"WeeklySchedule":{"RecurrenceWeeks":0,"RecurrenceDays":["string"]},
"MonthlySchedule":{"RecurrenceType":"string","DayRecurrence":{"DayInterval":0,"MonthInterval":0},"CustomRecurrence":{"WeekOfMonth":"string","DayOfWeek":"string","MonthInterval":0}},
"YearlySchedule":{"YearInterval":0,"RecurrenceType":"string","MonthRecurrence":{"MonthOfYear":"string","DayOfMonth":0},"CustomRecurrence":{"WeekOfMonth":"string","DayOfWeek":"string","MonthOfYear":"string"}}} |
Schedule has been updated successfully |
|
|
To delete a schedule |
DELETE:/api/v2.0/items/{id} |
{"id":"string"}
|
Item Deleted |
|
|
To run scheduled report |
GET:/api/v3.0/schedules/{scheduleId}/run |
{"scheduleId":"string"}
|
Schedule has been started successfully |
|
|
To get list of schedules |
GET:/api/v2.0/items?itemType=Schedule |
|
Return the list of item |
|