REST — SchedulesV2

Viewing, creating, modifying, and deleting schedules via the REST Web Service API is available in Exago v2021.1.1+. This feature requires Installing the Scheduler Service.

All requests require a Session Id URL parameter and basic request headers. In the following topic, headers are omitted in the interest of brevity.

Schedule JSON

A schedule is represented as a JSON object with the following properties:

Schedule Example

This example represents a schedule named Report Totals which will run a report named Employee Orders from the My Reports folder. When it runs, a PDF file with the password “abcd” will be generated an attached to an email sent to peter@mycompany.com.This schedule will run every hour starting at 9:00 AM until 5:00 PM every day of the week from March 1, 2021–June 1, 2021.

{
   "JobId":"4c835b79-56e3-4051-a0c3-6d21d9576bbc",
   "JobType":"Report",
   "ScheduleName":"Report Totals",
   "ReportName":"My ReportsEmployee Orders",
   "ReportId":"9b5d7d7f-53fe-4db3-8914-c5c3fad9fb70",
   "Status":"Ready",
   "ExportType":"Pdf",
   "Password":"abcd",
   "IsArchive":false,
   "Recurrence":{
      "IsImmediate":false,
      "RecurrenceType":"Daily",
      "RecurrenceRange":"EndByDate",
      "ScheduleTime":"09:00",
      "RepeatEvery":true,
      "RepeatEveryHours":1,
      "RepeatEveryMinutes":0,
      "RepeatEveryEndTime":"17:00",
      "RangeStartDate":"2021-03-01",
      "RangeEndDate":"2021-06-01",
      "OccurrencesToEnd":1,
      "RecurrencePattern":{
         "Once":null,
         "Daily":{
            "IsEveryWeekday":true,
            "DailyNumberOfDaysInterval":0
         },
         "Weekly":null,
         "Monthly":null,
         "Yearly":null
      }
   },
   "Filters":null,
   "FilterValues":null,
   "Parameters":[
      
   ],
   "Batch":null,
   "Recipients":{
      "EmailResults":true,
      "AttachOutputToEmail":true,
      "ToAddresses":[
         "peter@mycompany.com"
      ],
      "CcAddresses":[
         
      ],
      "BccAddresses":[
         
      ],
      "ReplyToAddresses":[
         
      ],
      "EmailSubject":"Hourly order update",
      "EmailBody":"Please find the hourly order update attached to this email."
   },
   "ParentJobId":"9f0b39c0-3170-4ca1-ac21-e830356bf6fb"
}

List All Schedules

List all of the schedules in the current configuration. Returns an array of ScheduleListItem JSON objects, each representing an individual schedule.

GET /rest/SchedulesV2

Create New Schedule

Create a new schedule. The ScheduleName and ReportName are required. Returns HTTP 201 Created with a Schedule object representing the new schedule.

POST /rest/SchedulesV2

Example

This example creates a new schedule named MyTestSchedule. This schedule will run a report named Products by Category from the ExpressViews folder 10 times, starting on October 17, 2019. The report will run at 2:45 PM only on weekdays. The output will be saved as a PDF file to a directory on the server’s file system.

{
   "ScheduleName":"MyTestSchedule",
   "ReportName":"ExpressViewsProducts by Category",
   "ExportType":"Pdf",
   "Recurrence":{
      "IsImmediate":false,
      "RecurrenceType":"Daily",
      "RecurrenceRange":"EndAfterNOccurences",
      "ScheduleTime":"14:45",
      "RepeatEvery":false,
      "RangeStartDate":"2019-10-17",
      "RangeEndDate":null,
      "OccurrencesToEnd":10,
      "RecurrencePattern":{
         "Daily":{
            "IsEveryWeekday":true,
            "DailyNumberOfDaysInterval":0
         }
      }
   }
}

Show a Schedule

Show the properties of the schedule specified by the scheduleID. Returns a Schedule object representing the schduleID requested.

GET /rest/SchedulesV2/{scheduleID}

Edit a Schedule

Edit the properties of the schedule specified by the scheduleID. Include only those properties to be updated. Returns no JSON objects but will return HTTP status code 204 to indicate success.

PATCH /rest/SchedulesV2/{scheduleID}

Example

This example changes the ExportType of the schedule with ID aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee to be RTF.

PATCH /schedulesv2/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee

{ "ExportType": "Rtf"}

Delete a Schedule

If the specified schedule is active (that is, it is not Completed or Deleted) it will be set to Deleted status. If the specified schedule is inactive, it will be flushed from the scheduler. Therefore, two calls must be made or a separate call to flush the scheduler must be made if the schedule was active when it deleted and the intention is to flush it. Returns no JSON objects but will return HTTP status code 204 to indicate success.

DELETE/rest/SchedulesV2/{scheduleID}

Example

This example marks schedule with ID aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee as Deleted.

DELETE /rest/SchedulesV2/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee

Flush the Scheduler

Flush the scheduler of all Completed and Deleted schedules. An array of ScheduleListItem will be returned with the resulting schedule list after the flush has occurred.

POST /rest/SchedulesV2/Flush

ScheduleListItem JSON

A JSON object which represents an item in the schedule list. An array of ScheduleListItem is returned when calling GET /SchedulesV2

Example

This array contains one ScheduleListItem representing a daily recurring schedule that has already run once and will run again the following hour.

{
   "Id":"4c835b79-56e3-4051-a0c3-6d21d9576bbc",
   "ParentJobId":"9f0b39c0-3170-4ca1-ac21-e830356bf6fb",
   "ScheduleName":"Report Totals",
   "Type":"Daily",
   "ReportName":"Employee Orders",
   "LastExecDate":"2021-02-12T21:46:37Z",
   "NextExecDate":"2021-02-12T22:00:00Z",
   "Status":"Ready",
   "RunCount":1,
   "UserId":"Fiona Light",
   "CompanyId":"Tip O' The Nose Services, LLC",
   "JobType":"Report"
}

ScheduleRecurrence JSON

A JSON object representing a schedule recurrence pattern.

ScheduleRecurrencePattern JSON

A JSON object representing a schedule recurrence pattern. The pattern selected here should match the RecurrenceType set in ScheduleRecurrence.

Pick one and only one of the properties.

OncePattern JSON

A JSON object representing a schedule that does not recur, but runs only one time.

DailyPattern JSON

A JSON object representing a schedule recurrence pattern which occurs on a day-to-day basis

Example

This Daily recurrence pattern runs every weekday.

{	
	"IsEveryWeekday": true
}

WeeklyPattern JSON

A JSON object representing a schedule recurrence pattern which occurs on a weekly basis.

Example

In this example, the schedule will run every Sunday, Wednesday and Saturday of the week.

{
   "WeeklyNumberOfWeeksInterval":"1",
   "WeeklyDaysOfWeek":[
      true,
      false,
      false,
      true,
      false,
      false,
      true
   ]
}

MonthlyPattern JSON

A JSON object representing a schedule recurrence pattern which occurs on a monthly basis.

Example

In this example, the schedule will run on the second Monday of every other month.

{
   "IsOnSpecificDayOfMonth":false,
   "MonthlyDayPosition":"second",
   "MonthlyDayOfWeek":"mon",
   "MonthlyRelativeEveryNMonths":2
}

YearlyPattern JSON

A JSON object which represents a yearly schedule recurrence pattern.

Examples

This example will run the schedule every year on the last Sunday in September.

{
   "IsOnSpecificDayOfYear":false,
   "YearlyRelativeDayPosition":"last",
   "YearlyRelativeDayOfWeek":"sun",
   "YearlyRelativeMonth":9
}

This example will run the schedule on April 15th of every year.

{
   "IsOnSpecificDayOfYear":true,
   "YearlySpecificMonth":"April",
   "YearlySpecficDayNumber":15
}

ScheduleFilterItem JSON

A JSON object representing a group of one or more ScheduleFilterElement objects, defining the grouping of the prompting filters on a non-composite (ExpressView, Express, Advanced, CrossTab) report.

ScheduleFilterElement JSON

A JSON object representing an individual filter on a non-composite (ExpressView, Express, Advanced, CrossTab) report.

Example

This Filters array represents the following filter summary from the Advanced Report Designer: Work Order Tickets.Open Date > '05/14/2017' And (Work Order Tickets.Description Contains 'lightning' And Work Order Tickets.Description Contains 'RMA')

"Filters":[
   {
      "Group":null,
      "Filter":{
         "FilterText":"Work Order Tickets.Open Date",
         "Operator":"GreaterThan",
         "AndFlag":true,
         "Values":[
            "2017-05-14 23:59:59.997"
         ]
      }
   },
   {
      "Group":[
         {
            "Group":null,
            "Filter":{
               "FilterText":"Work Order Tickets.Description",
               "Operator":"Contains",
               "AndFlag":true,
               "Values":[
                  "lightning"
               ]
            }
         },
         {
            "Group":null,
            "Filter":{
               "FilterText":"Work Order Tickets.Description",
               "Operator":"Contains",
               "AndFlag":true,
               "Values":[
                  "RMA"
               ]
            }
         }
      ],
      "Filter":null
   }
]

ScheduleCompositeFilter JSON

A JSON object representing a prompting filter on a composite (Chained or Dashboard) report. ScheduleCompositeFilter objects appear in an array in the Schedule object’s FilterValues property.

Example

This Schedule JSON object excerpt is from a scheduled Chained Report with two reports in the chain. It’s Filters property is null, but the FilterValues property contains an array of ScheduleCompositeFilter JSON objects, one for each prompting filter. Note the Employees.Eid applies to both reports in the chain.

"Filters":null,
"FilterValues":[
   {
      "Reports":[
         0
      ],
      "FilterText":"=Year({Employees.HireDate})",
      "Operator":"EqualTo",
      "AndFlag":true,
      "Values":[
         "2009"
      ]
   },
   {
      "Reports":[
         0,
         1
      ],
      "FilterText":"Employees.EID",
      "Operator":"OneOf",
      "AndFlag":true,
      "Values":[
         "4",
         "5",
         "6"
      ]
   },
   {
      "Reports":[
         1
      ],
      "FilterText":"=Year({Orders.OrderDate})",
      "Operator":"EqualTo",
      "AndFlag":true,
      "Values":[
         "2016"
      ]
   }
],

ScheduleParameter JSON

A JSON object representing a prompting parameter on the scheduled report.

ScheduleBatchInfo JSON

A JSON object representing the information for processing individualized scheduled reports, also known as a batch report. The individualized reports will be emailed to recipients based on a Data Object field contained within BatchEmailEntityCategory > BatchEmailEntity > BatchEmailField. A summary of the batch report’s execution will be sent by email to ToAddresses and CC’ed to CcAddresses.

Example

This example sends a copy of the schedule’s execution summary to peter@mycompany.com, and sends the individualized executed report to each entry with an EmailAddress in the Employees data object.

{
   "AttachReportToEmail":true,
   "ToAddresses":[
      "peter@mycompany.com"
   ],
   "CcAddresses":[
      
   ],
   "BatchEmailEntityCategory":"",
   "BatchEmailEntity":"Employees",
   "BatchEmailField":"EmailAddress"
}

ScheduleRecipientInfo JSON

A JSON object representing an email to send when the schedule has run and to optionally attach the report to the email.

Example

This example attaches the report output file to an email and sends it to peter@mycompany.com and ryan@mycompany.comThe email is CCed to alex@mycompany.com and bailey@mycompany.com, and BCCed to rachel@mycompany.com. All email messages will have a subject line of “Here is the report you needed” and the message “Attached is the report you had asked for!” will appear in the body of the email.

{
   "EmailResults":true,
   "AttachOutputToEmail":true,
   "ToAddresses":[
      "peter@mycompany.com",
      "ryan@mycompany.com"
   ],
   "CcAddresses":[
      "alex@mycompany.com",
      "bailey@mycompany.com"
   ],
   "BccAddresses":[
      "rachel@mycompany.com"
   ],
   "ReplyToAddresses":[
      
   ],
   "EmailSubject":"Here is that report you needed",
   "EmailBody":"Attached is the report you had asked for!"
}