There are a number of APIs available to help you automate the management of Schedules in L2L. This document will help you identify how the API aligns with the Scheduler tool. This is not a complete list of APIs and API methods. Please refer to the API documentation for the complete list.

Event Schedules

/api/1.0/eventschedule/

This API returns a list of schedules. This is just like opening the Scheduler → All Schedules screen.

Event Schedule Machines

/api/1.0/eventschedulemachine/

This API returns a list of all machines tied to a schedule. 

This API also includes a list of Planned resources and Additional resources tied to the Machine. This is the preferred way to get a list of resources who are assigned to a schedule.

Event Schedule Machine Occurrences

/api/1.0/eventschedulemachineoccurrence/

This API is used to see all future occurrences of a Machine schedule. You can see a list of future occurrences of a Machine by clicking the button in the "Next Occurrence" column in the Machine List.

Event Schedule Machine Resources: Add/Update

/api/1.0/eventschedulemachineresource/add_resource/
/api/1.0/eventschedulemachineresource/update_resource/

These two API methods are used to add and update resources tied to a Machine. The preferred method to retrieve resources on a machine is through the /eventschedulemachine/ API documented above.

Event Schedule Occurrence Types

/api/1.0/eventscheduleoccurrencetype/

This API is used to retrieve a list of a Schedule's Occurrence Types.

You can get a list of resources on the Schedule Occurrence Type and update those occurrence using the following methods:

/api/1.0/eventscheduleoccurrencetype/get_resource_schedule/
/api/1.0/eventscheduleoccurrencetype/set_resource_schedule/

Diagram

The following diagram illustrates how each of the APIs relate to each other: