Listing All Registered Calendar Names

The following method returns the list of all calendar names that were added to the scheduler.

Method

URL

GET

http://<host>:<port>/jasperserver[-pro]/rest_v2/jobs/calendars/?<parameter>

Argument

Type/Value

Description

calendar
Type

optional string

A type of calendar to return: annual, base, cron, daily, holiday, monthly, or weekly. See Adding or Updating an Exclusion Calendar for a description of the various types. You may specify only one calendarType parameter. When calendarType isn't specified, then all calendars names are returned. If calendarType has an invalid value, then an empty collection is returned.

Return Value on Success

Typical Return Values on Failure

200 OK – Body is XML that contains a list of calendar names.

401 Unauthorized

The list of calendar names in the result has the following XML format:

<calendarNameList>
  <calendarName>name1</calendarName>
  <calendarName>name2</calendarName>
</calendarNameList>
Version: 
Feedback
randomness