| Name | Description | |
|---|---|---|
 | CreateDailySchedule | Schedule the Api object's active report to run on a daily interval. |
| CreateEveryNDaySchedule | Overloaded. Schedule the Api object's active report to run every N number of days. |
| CreateEveryWeekdaySchedule | Overloaded. Schedule the Api object's active report to run every weekday. |
| CreateImmediateSchedule | Schedule the Api object's active report to be executed immediately. |
| CreateMonthlySchedule | Schedule the Api object's active report to run every N months. |
| CreateMonthlyScheduleByDescriptionDay | Overloaded. Schedule the Api object's active report to run every month with a relative recurrence period (e.g. "on the third Wednesday of the month" or "on the last day of the month") |
| CreateMonthlyScheduleByNumericDay | Overloaded. Schedule the Api object's active report to run every month on a specific day of that month (e.g. when numericDay is 30, the schedule will run on the 30th of every month. If the month does not have that day (e.g. February does not have 30 days) then the schedule will be adjusted back to the closest day to insure the schedule is executed (e.g. the schedule will run on February 28 instead). |
| CreateOnceScheduleByDateTime | Schedule the Api object's active report to run only a single time. |
| CreateWeeklySchedule | Overloaded. Schedule the Api object's active report to run every N weeks. |
| CreateYearlySchedule | Schedule a report to be run on a yearly interval. Report will be executed until the recurrence completion conditions have been met |
| CreateYearlyScheduleByDescriptionDay | Overloaded. Schedule the Api object's active report to run every year. |
| CreateYearlyScheduleByNumericDay | Overloaded. Schedule the Api object's active report to run year on a specific day of the year. |
| DeleteSchedulerJob | Delete a scheduled job by providing the job's ID. The job will be first stopped and the cache cleared before it is deleted. |
| Flush | Completed and canceled schedules and archives may be periodically removed from the list by calling this method. |
| GetAllHosts | Retrieve a list of configured Scheduler Service hosts in the configuration. |
| GetApiReportScheduleInfoListByName | Retrieves a list of ApiReportScheduleInfo objects based on the schedule name (the same as the Schedule Name column in the user interface Schedule Manager). (Similar to GetFirstApiReportScheduleInfoByScheduleName Method). |
| GetFirstApiReportScheduleInfoByScheduleName | Retrieves the first schedule job with the matching name, since schedule names are not required to be unique. To retrieve a list of matching schedules by name, use the GetApiReportScheduleInfoListByName Method instead. |
| GetHost | Retrieve information about a specific Scheduler Service in the configuration. |
| GetJobList | Retrieve a list of Scheduler Service jobs, organized by Scheduler Service host. |
| GetJobStatus | Retrieve the status of a scheduled report job, by providing the index of the Scheduler Service host and the job's ID. |
| GetReportScheduleInfoByJobId |
Returns the ReportScheduleInfo with the jobId provided. If none is found, an exception is thrown |
| SetExecParameters |
Sets the parameters used in the execution to the Parameter Collection from the Api, or one created by the user. |
| SetRecurrencePatternDaily | Change an existing schedule (provided via a ReportScheduleInfo object) to a Daily recurrence pattern. |
| SetRecurrencePatternMonthly | Convenience method that sets the provided ReportScheduleInfo's RecurrencePattern to Monthly with provided parameters. |
| SetRecurrencePatternOnce | Convenience method that sets the provided ReportScheduleInfo's RecurrencePattern to Once with the provided parameters. |
| SetRecurrencePatternWeekly | Convenience method that sets the provided ReportScheduleInfo's RecurrencePattern to Weekly with provided parameters. |
| SetRecurrencePatternYearly | Convenience method that sets the provided ReportScheduleInfo object's recurrence pattern to yearly |
| UpdateExistingSchedule | Update an existing Scheduler Service job with new information. |
Exago .NET API Documentation
ReportScheduler Class Methods