Cisco Tidal Enterprise Scheduler 6.2 REST API Reference Guide
Bias-Free Language
The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
- Updated:
- June 9, 2014
Chapter: Calendar
Overview
TES 6.2 provides predefined calendars. A scheduled job has an associated calendar. TES 6.2 users may create custom 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.
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.
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 .
Feedback