This method creates a named exclusion calendar that you can use when scheduling reports. If the calendar already exists, you have the option of replacing it and updating all the jobs that used it.
| Method | URL | ||
| PUT | http://<host>:<port>/jasperserver[-pro]/rest_v2/jobs/calendars/<calendarName>?<arguments> | ||
| Argument | Type/Value | Description | |
| replace? | true / false | If true, any calendar existing in the JobStore with the same name is overwritten. When this argument is omitted, it is false by default. | |
| update | true / false | Whether or not to update existing triggers that referenced the already existing calendar so that they are based on the new trigger. | |
| Content-Type | Content | ||
| application/xml | A well-formed XML calendar descriptor (see examples below). | ||
| Return Value on Success | Typical Return Values on Failure | ||
| 200 OK – | 404 Not Found – When the specified calendar name does not exist. | ||
The following examples show the types of exclusion calendars that you can add to the scheduler:
| • | Base calendar. |
| • | Annual calendar – A list of days that you want to exclude every year. |
| • | Cron calendar – Defines the days and times to exclude as a cron expression. |
| • | Daily calendar – Defines a time range to exclude every day. |
| • | Holiday calendar – Defines a set of days to exclude that can be updated every year. |
| • | Weekly calendar – Defines a set of days to be excluded each week. |
| • | Monthly calendar – Defines the dates to exclude every month. |
Recommended Comments
There are no comments to display.