Overview
TES 6.2 provides predefined calendars. A scheduled job has an associated calendar. TES 6.2 users may create custom calendars.
Calendar Type
Currently supported calendar types include:
-
Fiscal Calendar
-
Custom Calendar
Typical Operations
-
Get a list of available calendars
-
Compile a single calendar
-
Compile all calendars
REST API Examples
From the browser, issue and then click
Manual Commands (Post)
to take you to the API post screen of the client. You can test the REST API examples from this screen. For valid parameters and successful execution of a request, you will get a response/result. For invalid parameters and unsuccessful execution of a request, you will get error messages and/or exceptions.
Example CAL–1: Get a list of available calendars
The
Calendar
object provides a method called
getList
. It has no parameters. The following REST API call will return a list of calendars.
<?xml version="1.0" encoding="UTF-8"?> <entry xmlns="http://purl.org/atom/ns#"> <tes:Calendar.getList xmlns:tes="http://www.tidalsoftware.com/client/teservlet">
Example CAL–2: Get a specific calendar
The
Calendar
object provides a method called
getList
. The parameter called
id
(e.g. 30) is required, and specifies the calendar to be retrieved. The following REST API call will return the specified calendar if it exists and an exception if the calendar cannot be found.
<?xml version="1.0" encoding="UTF-8"?> <entry xmlns="http://purl.org/atom/ns#"> <tes:Calendar.get xmlns:tes="http://www.tidalsoftware.com/client/teservlet">
Example CAL–3: Compile a single calendar
The
Calendar
object provides a method called
compileSingleCalendar
. The parameter called
id
(e.g. 30) specifies the calendar instance to be compiled. The following REST API call will compile the calendar with
id
12
.
<?xml version="1.0" encoding="UTF-8"?> <entry xmlns="http://purl.org/atom/ns#"> <tes:Calendar.compileSingleCalendar xmlns:tes="http://www.tidalsoftware.com/client/teservlet"> </tes:Calendar.compileSingleCalendar>
Example CAL–4: Compile all calendars
The
Calendar
object also provides a method called
compileCalendars
.The parameter called
id
(e.g. 1) is required, but ignored. The following REST API call will compile all calendars.
<?xml version="1.0" encoding="UTF-8"?> <entry xmlns="http://purl.org/atom/ns#"> <tes:Calendar.compileCalendars xmlns:tes="http://www.tidalsoftware.com/client/teservlet"> </tes:Calendar.compileCalendars>