Cisco Tidal Enterprise Scheduler 6.2.1 SP2 RESTAPI Reference Guide

10m ago
15 Views
1 Downloads
3.89 MB
226 Pages
Last View : 4d ago
Last Download : 5m ago
Upload by : Randy Pettway
Transcription

Cisco Tidal Enterprise Scheduler 6.2.1 SP2 REST API Reference Guide June 23, 2015 Americas Headquarters Cisco Systems, Inc. 170 West Tasman Drive San Jose, CA 95134-1706 USA http://www.cisco.com Tel: 408 526-4000 800 553-NETS (6387) Fax: 408 527-0883 Text Part Number: OL-32206-01

THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE WITHOUT NOTICE. ALL STATEMENTS, INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR APPLICATION OF ANY PRODUCTS. THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE INFORMATION PACKET THAT SHIPPED WITH THE PRODUCT AND ARE INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE OR LIMITED WARRANTY, CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY. The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCB’s public domain version of the UNIX operating system. All rights reserved. Copyright 1981, Regents of the University of California. NOTWITHSTANDING ANY OTHER WARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWARE OF THESE SUPPLIERS ARE PROVIDED “AS IS” WITH ALL FAULTS. CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, THOSE OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM A COURSE OF DEALING, USAGE, OR TRADE PRACTICE. IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING, WITHOUT LIMITATION, LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE THIS MANUAL, EVEN IF CISCO OR ITS SUPPLIERS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL: www.cisco.com/go/trademarks. Third-party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company. (1110R) Any Internet Protocol (IP) addresses and phone numbers used in this document are not intended to be actual addresses and phone numbers. Any examples, command display output, network topology diagrams, and other figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses or phone numbers in illustrative content is unintentional and coincidental. Cisco Tidal Enterprise Scheduler 6.2.1 SP2 REST API Reference Guide 2015 Cisco Systems, Inc. All rights reserved.

CONTENTS Preface 7 Audience 7 Related Documentation 7 Obtaining Documentation and Submitting a Service Request Document Change History 7 Introducing the TES REST API Overview 1-9 1-9 REST API Objects 1-9 REST API Call Template Using the TES REST API Overview 7 1-10 2-11 2-11 REST API from a Browser 2-11 REST API Security Notes 2-12 Java Client REST API Examples 2-12 Code Example 1 – GET Request 2-12 Code Example 2 – POST Request 2-13 Code Example 3 – Session Management Using the Session Cookie Code Example 4 – Execute a Query with Conditions 2-15 TES APIs in the WebService Adapter TES APIs in the SOAP UI Tool Calendar 2-14 2-15 2-16 3-15 Overview 3-15 Calendar Type 3-15 Typical Operations 3-15 Calendar Examples 3-15 Calendar Example 1 – Get a list of available calendars 3-16 Calendar Example 2 – Get a specific calendar 3-16 Calendar Example 3 – Compile a single calendar 3-16 Calendar Example 4 – Compile all calendars 3-17 Calendar Example 5 – Create a list calendar 3-17 Cisco Tidal Enterprise Scheduler 6.2 REST API Reference Guide OL-32206-01 iii

Contents Specifying Calendar Days 3-18 Calendar Example 6 – Create a group calendar 3-19 Calendar Example 7 – Create a daily calendar with details and a condition 3-20 Calendar Example 8 – Delete a detail in a calendar 3-21 Calendar Example 9 – Delete a condition in a calendar 3-21 Calendar Example 10 – Add details and conditions in a group calendar 3-22 Calendar Example 11 – Delete calendar days in a list calendar 3-23 Calendar Example 12 – Add calendar days to a list calendar 3-23 Calendar Example 13 – Delete a condition in a daily calendar 3-25 Calendar Example 14 – Add a condition to a daily calendar 3-25 Calendar Example 15 – Delete a calendar 3-26 Job 4-1 Overview 4-1 Job Type 4-1 Job Instance 4-2 Typical Operations 4-2 Job Examples 4-2 Job Example 1 – Get a list of available Job definitions 4-2 Job Example 2 – Get a specific Job definition 4-3 Job Example 3 – Create a simple Job 4-3 Job Example 4 – Create a Job with many parameters 4-3 Job Example 5 – Insert a Job into the schedule 4-4 Job Example 6 – Update a JobGroup with a variable update Job Example 7 – Update an SAP ServiceJob 4-5 JobRun 4-5 5-23 Overview 5-23 JobRun Type 5-23 Typical Operations 5-23 JobRun Examples 5-24 JobRun Example 1 – Override a JobRun instance 5-24 JobRun Example 2 – Override a JobDependency instance of a JobRun JobRun Example 3 – Cancel a JobRun 5-25 JobRun Example 4 – Set the status of a JobRun 5-25 JobRun Example 5 – Hold a JobRun 5-25 JobRun Example 6 – Release a JobRun 5-25 JobRun Example 7 – Rerun a JobRun 5-26 5-24 Cisco Tidal Enterprise Scheduler 6.2 REST API Reference Guide iv OL-32206-01

Contents Node 6-27 Overview 6-27 Node Type 6-27 Typical Operations 6-28 Node Examples 6-28 Node Example 1 – Get a list of available nodes 6-28 Node Example 2 – Create a schedule in the master 6-29 Node Example 3 – Add an agent node and enable it 6-29 Node Example 4 – Enable or disable a Windows node 6-29 Action 7-1 Overview 7-1 Action Type 7-1 Typical Operations 7-1 Action Examples 7-2 Action Example 1 – Get a list of available actions 7-2 Action Example 2 – Set the value of a variable 7-2 Action Example 3 – Create a value variable 7-2 Action Example 4 – Update the value of a variable 7-3 Action Example 5 – Update a variable 7-3 Action Example 6 – Create a web service action 7-4 Action Example 7 – Create a web service action with parameters Queues 8-5 Overview 8-5 Typical Operations 8-5 Queue Examples 8-5 Queue Example 1 – Enable a queue 8-5 Appendix A—REST API Object Descriptions Actions A-7 A-8 AdapterLicense AgentLicense AgentList AgentNode A-8 A-9 A-9 AgentListJoin A-10 A-10 AlarmptAction Alert 7-4 A-10 A-11 AlertAction A-12 Cisco Tidal Enterprise Scheduler 6.2 REST API Reference Guide OL-32206-01 v

Contents BackupMasterNode BusinessUnit A-14 BusinessView Calendar A-13 A-15 A-15 CalendarChild A-17 CalendarCondition A-17 CalendarPrint A-18 CalendarYear A-19 CalendarYear2 A-19 DataMoverJob A-20 DataMoverJobRun A-23 DependencyUnion A-28 EmailAction A-29 EventActionJoin A-30 EventActionRun A-30 EventCalendarJoin A-32 EventJobClassJoin A-32 EventJobJoin Events A-33 A-33 EventsFile A-35 EventsJob A-36 EventsService A-37 EventsSystem A-38 EventsVariable A-39 FaultMonitorNode FileDependency A-41 A-42 FiscalCalendar A-43 FolderConfiguration FTPJob A-43 A-44 FTPJobRun A-47 ImageRepository A-52 ImageRepositoryLink InfoNodeJoin A-53 InterMasterVariable ITOAction A-52 A-53 A-54 Cisco Tidal Enterprise Scheduler 6.2 REST API Reference Guide vi OL-32206-01

Contents JESDependency Job A-54 A-55 JobAction A-58 JobClass A-59 JobDependency JobGroup A-60 JobOutput JobPrint A-60 A-63 A-64 JobReport JobRun A-67 A-67 JobRunDep A-71 JobRunGroup A-72 JobRunResource A-76 JobRunStatistics A-76 JobRunStatus A-77 JobRunSystemResourceDetails LogAction A-78 MasterJavaTimeZone MasterLicense A-78 A-79 MasterNode A-80 MasterVariables A-81 MessageCatalog A-81 MessageLog MPEJob A-82 A-83 MPEJobRun MPENode A-86 A-89 MVSAgentList MVSNode Node A-91 A-92 A-93 NodeOutage A-95 NodeResourceValue NullContent OS400Job A-95 A-96 A-96 OS400Node OSJob A-77 A-100 A-102 Cisco Tidal Enterprise Scheduler 6.2 REST API Reference Guide OL-32206-01 vii

Contents OSJobRun A-104 OVMSAgentList OVMSBatch A-108 A-109 OVMSBatchJobRun OVMSCommand A-112 A-116 OVMSCommandJobRun OVMSJob A-122 OVMSJobRun A-125 OVMSNode A-129 OwnerAgent Owners Queue A-130 A-131 A-131 QueuedJobRun QueueFilter A-133 A-134 RemoteMasterNode Resource A-135 A-137 ResourceJobJoin A-137 ResourceJobJoin2 A-138 ResourceJobLocks A-139 ResourceLock A-139 ResourceNodeJoin Schedules A-140 A-140 SecurityPolicy A-142 SecurityServiceJoin Service A-144 A-144 ServiceAction A-145 ServiceAgentList A-146 ServiceDist A-147 ServiceJob A-147 ServiceJobRun A-150 ServiceNode A-154 SNMPAction A-155 Statistics A-119 A-156 StatisticsTotal A-157 SystemActivityMessage A-158 Cisco Tidal Enterprise Scheduler 6.2 REST API Reference Guide viii OL-32206-01

Contents SystemResource SystemValue A-159 UnixAgentList UnixNode UserJoin A-158 A-160 A-160 A-162 UserMessage A-163 UserSecurityPolicySet A-163 UserSecurityServiceSet Users A-164 A-165 UserService A-166 UserSession A-166 Variable A-167 VariableAction A-168 VariableDependency VirtualResource A-169 WindowsAgentList WindowsNode WorkGroup A-169 A-170 A-170 A-172 WorkGroupRunUser A-173 WorkGroupUserJoin A-173 ZOSGatewayNode A-174 Appendix B—REST API Objects and Methods B-177 Cisco Tidal Enterprise Scheduler 6.2 REST API Reference Guide OL-32206-01 ix

Contents Cisco Tidal Enterprise Scheduler 6.2 REST API Reference Guide x OL-32206-01

Preface This guide describes how to generate and use the Tidal Enterprise Scheduler 6.2 REST API. Audience This guide is for engineers who want to integrate their applications or systems with TES for Workload Management activities. Related Documentation See the Cisco Tidal Enterprise Scheduler 6.2 Documentation Overview for a list of all TES guides. Note We sometimes update the documentation after original publication. Therefore, you should also review the documentation on Cisco.com for any updates. Obtaining Documentation and Submitting a Service Request For information on obtaining documentation, submitting a service request, and gathering additional information, see What’s New in Cisco Product Documentation at: hatsnew.html. Subscribe to What’s New in Cisco Product Documentation, which lists all new and revised Cisco technical documentation, as an RSS feed and deliver content directly to your desktop using a reader application. The RSS feeds are a free service. Document Change History The table below provides the revision history for the REST API Reference Guide. Cisco Tidal Enterprise Scheduler 6.2 REST API Reference Guide OL-32206-01 7

Preface Preface Version Number Issue Date Reason for Change 6.2 May 2014 Updates for 6.2 release. 6.2.1 (SP2) May 2015 New examples for many of the REST objects. New Appendix A documenting all REST objects. New Appendix B for how to access REST objects and methods documentation. General content validation and editorial improvements throughout. Cisco Tidal Enterprise Scheduler 6.2 REST API Reference Guide 8 OL-32206-01

CH A P T E R 1 Introducing the TES REST API Overview TES (Tidal Enterprise Scheduler) is the premier enterprise job scheduling solution. In addition to the core functionality such as defining agents, agent lists, jobs, job groups, triggers, actions, events, and calendars, TES provides network support, monitoring and messaging services, security, flexibility, and fault tolerance. TES 6.2 allows developers and integrators to customize and/or extend the features using REST API described in this guide. This chapter introduces you to: “REST API Objects” “REST API Call Template” REST API Objects The basic foundation of REST API is an ApiObject. The ApiObject provides an abstraction of TES objects (thereby hiding the implementation details). ApiObject is the "root" class and is extended by the base objects such as Node and Action. The base classes are extended by additional objects such as MasterNode and AlertAction. A list of currently supported objects in REST API is described in Appendix (A). ApiObject has fields for maintaining the integrity of the TES data Model. The current list includes: lastChangeTime, revision, and revisionIndex ApiObject has a default behavior of CRUD operations. The list of operations currently includes: Create Api object – create() Retrieve Api object(s) – get(), getList() Update Api object – update() Delete Api object – delete() Some REST API objects may override the basic behavior of the CRUD methods. They may also support additional methods (for example, convenience methods). A list of selected methods in REST API is described in “Appendix B—REST API Objects and Methods”. Some commonly used objects and methods from REST API are covered in this guide. Cisco Tidal Enterprise Scheduler 6.2 REST API Reference Guide OL-32206-01 1-9

Chapter 1 Introducing the TES REST API REST API Call Template REST API Call Template REST API calls can be described using the following template. ?xml version "1.0" encoding "UTF-8"? entry xmlns "http://purl.org/atom/ns#" id id value /id tes:ApiObject.apiMethod xmlns:tes "http://www.tidalsoftware.com/client/tesservlet" tes:param1 param1 value /tes:param1 tes:paramN paramN value /tes:paramN /tes:ApiObject.apiMethod /entry Note The standard header specifies the use of XML version 1.0 and UTF-8 encoding. The entry tag specifies the name space ("")for Atom. An object for REST API has a primary key (identifier) specified by the id tag. The xml name space tes is defined as .tes:ApiObject.apiMethod is the fully qualified name of the method. A method can have one or more parameters. Cisco Tidal Enterprise Scheduler 6.2 REST API Reference Guide 1-10 OL-32206-01

CH A P T E R 2 Using the TES REST API Overview There are many ways to invoke the RESTful services available from Enterprise Scheduler. You can browse the services available via a browser as described in: “REST API from a Browser” You can use the Java client to call the services using the HttpURLConnection class as illustrated in: “Java Client REST API Examples” You can also access and use the TES REST API the WebService Adapter and the SOAP UI Tool as illustrated in these sections: “TES APIs in the WebService Adapter” “TES APIs in the SOAP UI Tool” In addition, you can use a wide variety of third party frameworks such as the Spring Framework RestTemplate or the Apache CXF Framework. REST API from a Browser Before writing code to invoke the REST API, you can browse the services available via a browser. In a live Enterprise Scheduler environment, the URL where the API can be reached is as follows: Figure 2-1 REST API browser view Cisco Tidal Enterprise Scheduler 6.2 REST API Reference Guide OL-32206-01 2-11

Chapter 2 Using the TES REST API REST API Security Notes Clicking on the links issues a "GET" request to the API. A "POST" request to the API can also be issued from the browser by using the "Manual Commands (Post)" link. Figure 2-2 REST API Post Screen REST API Security Notes The calls to the REST API are subject to the same security restrictions as the same user accessing Scheduler UI. In Code Example 1 below, a call is issued to get all of the available jobs. The list of available jobs returned is determined by the username used in the API call. Java Client REST API Examples This section provides four code examples that illustrate using the Java client REST API. “Code Example 1 – GET Request” “Code Example 2 – POST Request” “Code Example 3 – Session Management Using the Session Cookie” “Code Example 4 – Execute a Query with Conditions” Code Example 1 – GET Request The following Java client issues a GET request to the REST API. This is the equivalent of clicking on the ApiObject link as described in the REST API From Browser section. This example retrieves all of the jobs currently defined in the Scheduler environment. The username and password pair is Base64 encoded and passed to the server as the "Authorization" property. An XML document containing a list of jobs is returned from this call. public static void postRequest() throws Exception { URL url new 6.2/post"); HttpURLConnection conn (HttpURLConnection) url.openConnection(); conn.setRequestMethod("GET"); conn.setDoInput(true); conn.setDoOutput(true); Cisco Tidal Enterprise Scheduler 6.2 REST API Reference Guide 2-12 OL-32206-01

Chapter 2 Using the TES REST API Java Client REST API Examples String userNamePassword "myusername:mypassword"; userNamePassword new deBase64(userNamePassword .getBytes())); conn.setRequestProperty("Authorization", userNamePassword); conn.connect(); BufferedReader reader new BufferedReader(new InputStreamReader( conn.getInputStream())); String resp ""; String next null; while ((next reader.readLine()) ! null) resp next; System.out.println(resp); } Code Example 2 – POST Request Code Example 2 shows a POST request issued to the TES REST API. The URL for issuing a POST request is always the same: http:// hostname : port /api/ DSP Name / post. In the post request, the command to be executed is sent in an URL encoded string. In this particular example, a POST request is sent to insert a job into the schedule. The id is the id of the job. Other parameters include startdate - the requested runtime for the job; vars - local job variable overrides; params - local job parameter overrides; and deps - the Y/N value for whether or not to override the job's dependencies. An XML document acknowledging the job insert is returned. public static void postRequest() throws Exception { URL url new 6.2/post"); HttpURLConnection conn (HttpURLConnection) url.openConnection(); conn.setRequestMethod("POST"); conn.setDoInput(true); conn.setDoOutput(true); n/x-www-form-urlencoded"); String userNamePassword "myusername:mypassword"; userNamePassword new deBase64(userNamePassword .getBytes())); conn.setRequestProperty("Authorization", userNamePassword); String postCommand " ?xml version \"1.0\" encoding \"UTF-8\" standalone \"yes\" ? " " atom:entry xmlns:atom \"http://purl.org/atom/ns#\" " " atom:id 1 /atom:id atom:title api /atom:title " " Job.insert " " id 2 /id " " startdate 20110812 /startdate " " vars /vars " " params /params " " deps N /deps " " /Job.insert " " /atom:entry "; String payload "data " java.net.URLEncoder.encode(postCommand, "ISO-8859-1"); Cisco Tidal Enterprise Scheduler 6.2 REST API Reference Guide OL-32206-01 2-13

Chapter 2 Using the TES REST API Java Client REST API Examples conn.setRequestProperty("Content-Length", Integer.toString(payload.getBytes().length)); ).length); DataOutputStream out new DataOutputStream(conn.getOutputStream()); out.writeBytes(payload); out.flush(); BufferedReader reader new BufferedReader(new InputStreamReader( conn.getInputStream())); String resp ""; String next null; while ((next reader.readLine()) ! null) resp next; System.out.println(resp); } Code Example 3 – Session Management Using the Session Cookie In both previous code examples, the calls establish new sessions on the server. For typical applications that make repeated calls to the REST API, the best practice is to reuse the established sessions so that the server does not create excessive number of active sessions, which eventually could cause it to run out of memory. Code Example 3 is an extension of Code Example 1 showing the usages of a cookie for session management. public static void tesGetRequestWithSession() throws Exception { String sessionID null; for (int i 0; i 10; i ) { URL url new URL( 2/Job.getList"); HttpURLConnection conn (HttpURLConnection) url.openConnection(); conn.setRequestMethod("GET"); conn.setDoInput(true); conn.setDoOutput(true); if (sessionID null) { String userNamePassword " myusername:mypassword "; userNamePassword new deBase64(userNamePassword .getBytes())); conn.setRequestProperty("Authorization", userNamePassword); } else { conn.setRequestProperty("Cookie", sessionID); } conn.connect(); BufferedReader reader new BufferedReader(new InputStreamReader( conn.getInputStream())); String resp ""; String next null; while ((next reader.readLine()) ! null) Cisco Tidal Enterprise Scheduler 6.2 REST API Reference Guide 2-14 OL-32206-01

Chapter 2 Using the TES REST API TES APIs in the WebService Adapter resp next; System.out.println(resp); //extract cookie String setCookies conn.getHeaderField("Set-Cookie"); if (setCookies ! null && sessionID null) { String cookies[] setCookies.split(";"); if (cookies.length 0) sessionID cookies[0]; } } } Code Example 4 – Execute a Query with Conditions In Code Example 1, a GET request was issued to get a list of all jobs. The GET request can accept additional parameters such that the list of jobs returned can be filtered further. If one needs to get a list of jobs that match a specific name pattern, the GET request URL can be constructed as follows: URL url new s6.2/Job.getList?query (Job.name LIKE '%name%')") In this case a where clause (Job.name LIKE '%name%') is sent. The where clause must be URL encoded. Similarly, other queries using other field names in the Job object can be constructed. The same also be achieved using a POST request. The POST payload is below. In addition to the queryCondition, using the POST one could also specify columns needed. ?xml version "1.0" encoding "UTF-8" standalone "yes"? atom:entry xmlns:atom "http://purl.org/atom/ns#" atom:id 1 /atom:id atom:title api /atom:title Job.getList selectColumns id,ownerid,parentid,parentname,runtimeusername /selectColumns queryCondition (Job.name LIKE '%name%') /queryCondition /Job.getList /atom:entry TES APIs in the WebService Adapter TES APIs can be accessed as a TES WebService job as shown here. Cisco Tidal Enterprise Scheduler 6.2 REST API Reference Guide OL-32206-01 2-15

Chapter 2 Using the TES REST API TES APIs in the SOAP UI Tool TES APIs in the SOAP UI Tool TES APIs can be accessed from SOAP UI tool. The request should be in XML format. The XML Request should be sent to: http:// ClientManager server hostname : port /api/ Plugin Name /postbody as shown below. Cisco Tidal Enterprise Scheduler 6.2 REST API Reference Guide 2-16 OL-32206-01

Chapter 2 Using the TES REST API TES APIs in the SOAP UI Tool Cisco Tidal Enterprise Scheduler 6.2 REST API Reference Guide OL-32206-01 2-17

Chapter 2 Using the TES REST API TES APIs in the SOAP UI Tool Cisco Tidal Enterprise Scheduler 6.2 REST API Reference Guide 2-18 OL-32206-01

CH A P T E R 3 Calendar 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: Daily calendar Group calendar List calendar Monthly calendar with days Monthly calendar with weeks Subset calendar Weekly calendar Typical Operations Get a list of available calendars Get a specific calendar Compile a single calendar Compile all calendars Calendar Examples Here we provide examples for basic calendar operations. We also provide more complex operations for daily, list, and group calendars like adding and deleting details and conditions and updating calendars. Cisco Tidal Enterprise Scheduler 6.2 REST API Reference Guide OL-32206-01 3-15

Chapter 3 Calendar Calendar 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. Calendar Example 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#" id xxx /id tes:Calendar.getList xmlns:tes "http://www.tidalsoftware.com/client/tesservlet" /tes:Calendar.getList /entry Calendar Example 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#" id xxx /id tes:Calendar.get xmlns:tes "http://www.tidalsoftware.com/client/tesservlet" tes:id 30 /tes:id /tes:Calendar.get /entry Calendar Example 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#" id xxx /id tes:Calendar.compileSingleCalendar xmlns:tes "http://www.tidalsoftware.com/client/tesservlet" tes:id 30 /tes:id /tes:Calendar.compileSingleCalendar /entry Cisco Tidal Enterprise Scheduler 6.2 REST API Reference Guide 3-16 OL-32206-01

Chapter 3 Calendar Calendar Examples Calendar Example 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#" id xxx /id tes:Calendar.compileCalendars xmlns:tes "http://www.tidalsoftware.com/client/tesservlet" /tes:Calendar.compileCalendars /entry Calendar Example 5 – Create a list calendar The following REST API call will create a list calendar that specifies three dates. See “Specifying Calendar Days” following the example to learn how calendar days are specified. ?xml version "1.0" encoding "UTF-8"? entry xmlns "http://purl.org/atom/ns#" title HTTP /title tes:Calendar.create xmlns:tes "http://www.tidalsoftware.com/client/tesservlet" tes:calendar tes:frequency 0 /tes:frequency tes:weekdays NNNNNNN /tes:weekdays tes:type 6 /tes:type tes:id -2 /tes:id tes:createtime 2015-06-06T00:43:21-0700 /tes:createtime tes:monthdays NNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN /tes:monthdays tes:ownername testuser /tes:ownername tes:intsect N /tes:intsect tes:description My description -- Deployed from WIN-7EL8UQCDFGG by domain\testuser on 06/06/2015 12:43:48 AM /tes:description tes:untildate 2018-12-31T00:00:00-0800 /tes:untildate tes:name test list /tes:name tes:untildateasstring 20181231000000 /tes:untildateasstring tes:offset 0 /tes:offset tes:forecastdate 2018-12-31T00:00:00-0800 /tes:forecastdate tes:ownerid 1 /tes:ownerid tes:pub Y /tes:pub tes:weeks NNNNN /tes:weeks tes:forecastdateasstring 20181231000000 /tes:forecastdateasstring tes:months NNNNNNNNNNNN /tes:months tes:typestring List /tes:typestring /tes:calendar reqops xmlns "" xmlns:ns3 "http://purl.org/atom/ns#" objid "uid-2"/ /tes:Calendar.create tes:CalendarYear.create xmlns:tes "http://www.tidalsoftware.com/client/tesservlet" tes:calendaryear tes:calendarname test list /tes:calendarname tes:dates1 Y Y /tes:dates1 tes:calendaryear 2015 /tes:calendaryear tes:dates2 Y /tes:dates2 tes:calendarid 207 /tes:calendarid /tes:calendaryear reqops xmlns "" xmlns:ns3 "http://purl.org/atom/ns#" objid "uid-21" setprop objid "uid-2" writeprop "calendarId" readprop "@result"/ Cisco Tidal Enterprise Scheduler 6.2 REST API Reference Guide OL-32206-01 3-17

Chapter 3 Calendar Calendar Examples /reqops /tes:CalendarYear.create /entry Specifying Calendar Days TES uses two parameters, dates1 and dates2, to identify date periods. dates1 specifies dates in the first half of the year and dates2 specifies dates in the second half of the year. The actual dates in each parameter vary slightly in regular years versus leap years as follows: Parameter Dates Number of Days dates1 January 1-July 2 183 days dates2 July 3-December 31 182 days dates1 January 1-July 1 183 days dates2 July 2-December 31 183 days Regular year Leap year (includes February 29) To specify a particular calendar day, you need to enter a space for each day in the period (up to 182 or 183) with a “Y” in the position of the date. You can specify multiple dates in a period. For example, let’s say that you want to specify three calendar dates. In the TES client interface, the dates would be specified as shown here for a calendar named Sample List Cal: In the REST API, you would specify two dates in the dates1 parameter and the third date in dates2 as shown here: tes:calendaryear tes:calendarname Sample List Cal /tes:calendarname Cisco Tidal Enterprise Scheduler 6.2 REST API Reference Guide 3-18 OL-32206-01

Chapter 3 Calendar Calendar Examples tes:dates1 Y Y /tes:dates1 tes:calendaryear 2015 /tes:calendaryear tes:dates2 Y /tes:dates2 tes:calendarid 207 /tes:calendarid /tes:calendaryear .where there is a space character for every day in the period preceding the specified dates. When specifying calendar days for dates1 and dates2, keep these rules in mind: Only the parameter containing the date you are

Contents iv Cisco Tidal Enterprise Scheduler 6.2 REST API Reference Guide OL-32206-01 Specifying Calendar Days 3-18 Calendar Example 6 - Create a group calendar 3-19 Calendar Example 7 - Create a daily calendar with details and a condition 3-20 Calendar Example 8 - Delete a detail in a calendar 3-21 Calendar Example 9 - Delete a condition in a calendar 3-21

Related Documents:

This guide describes how to the Command Line Prog ram for Cisco Tidal Enterprise Scheduler (TES) 6.2. Audience This guide is for administrators who want to use the Command Line program to automate TES job control functions. Related Documentation See the Cisco Tidal Enterprise Scheduler 6.2 Documentation Overview for a list of all TES guides.

Cisco ASA 5505 Cisco ASA 5505SP Cisco ASA 5510 Cisco ASA 5510SP Cisco ASA 5520 Cisco ASA 5520 VPN Cisco ASA 5540 Cisco ASA 5540 VPN Premium Cisco ASA 5540 VPN Cisco ASA 5550 Cisco ASA 5580-20 Cisco ASA 5580-40 Cisco ASA 5585-X Cisco ASA w/ AIP-SSM Cisco ASA w/ CSC-SSM Cisco C7600 Ser

Migrating From the SAP Scheduler to Tidal 1. Set up Tidal Automation 2. Set up the Tidal for SAP ERP adapter 3. Manage your SAP jobs through Tidal 4. Expand your use of Tidal to other systems Tidal'sSAP ERP adapter two-way synchronization allows you to: Monitor and edit your jobs through the SAP user interface

1 Cisco Tidal Enterprise Scheduler 6.2 Tutorial Guide for Unix OL-32204-01 CONTENTS Preface 7 Audience 7 Related Documentation 7 Obtaining Documentation and Submitting a Service Request 7 Scheduler Concepts 1-1 Overview 1-1 Prerequisites 1-1 System Configurations 1-2 Masters 1-2 Client Manager 1-3 Agents 1-3 Job Definition 1-3 Job Hierarchy 1-4 Dependencies 1-4 Date and Time

The Tidal Enterprise Scheduler (TES) Amazon S3 Adap ter automates the execution of Amazon S3 jobs as a part of TES’s managed process. It is an API-level integration solution. As a platform independent solution, the Amazon S3 Adapter can run on any platform where the Enterprise Scheduler master runs.

Cisco Tidal Enterprise Scheduler is an automation platform for cross-application and cross-platform enterprise workloads, batch job scheduling, and data and application integration. Cisco TES can easily configure and run scheduled batch work

The Tidal Reporting application provided the following additional functionality separate from TIDAL Enterprise Scheduler: 1. Out of the box approx. 60 queries that provide additional analysis on Tidal data not provided by the Tidal application. The queries range from a

Supported Devices - Cisco SiSi NetFlow supported Cisco devices Cisco Catalyst 3560 Cisco 800 Cisco 7200 Cisco Catalyst 3750 Cisco 1800 Cisco 7600 Cisco Catalyst 4500 Cisco 1900 Cisco 12000 Cisco Catalyst 6500 Cisco 2800 Cisco ASR se