schedule

Schedule

Functions

This module offers a collection of functions designed to address specific tasks and provide utilities for various purposes. Explore the available functions to make the most of the functionalities provided by this module.

• elements_schedule_get_schedule_events
• elements_schedule_create_schedule_event
• elements_schedule_get_schedule_event_by_name_or_id
• elements_schedule_update_schedule_event
• elements_schedule_delete_schedule_event
• elements_schedule_get_schedule_progresses
• elements_schedule_get_schedules
• elements_schedule_create_schedule
• elements_schedule_get_schedule_by_name_or_id
• elements_schedule_update_schedule
• elements_schedule_delete_schedule

---

Back To Top

elements_schedule_get_schedule_events

Elements Operation: getScheduleEvents

This function searches all schedules in the system and returns a number of matches against the given search filter, delimited by the offset and count.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback Function.

Syntax:

elements_schedule_get_schedule_events(_schedule_name_or_id, _offset=undefined, _count=undefined, _tags=undefined, _search=undefined, _callback=undefined)

Argument	Type	Description
_schedule_name_or_id	String	The name or ID of the schedule.
_offset	Real	The offset of the first result to return in the page.
_count	Real	The number of results to return in the page.
_tags	Array of String	An array specifying tags (see tags Property).
_search	String	The search filter to use.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

N/A

Triggers:

Callback Function

Key	Type	Description
_status	Real
_data	ElementsPaginationScheduleEvent
_request	ElementsRequest

---

Back To Top

elements_schedule_create_schedule_event

Elements Operation: createScheduleEvent

Supplying a schedule object, this function will create a new schedule with a newly assigned unique ID. The ScheduleEvent representation returned in the response body is a representation of the ScheduleEvent as persisted with a unique identifier assigned and with its fields properly normalized. The supplied schedule object submitted with the request must have a name property that is unique across all items.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback Function.

Syntax:

elements_schedule_create_schedule_event(_schedule_name_or_id, _body=undefined, _callback=undefined)

Argument	Type	Description
_schedule_name_or_id	String	The name or ID of the schedule.
_body	ElementsCreateScheduleEventRequest	The body to be included in the HTTP request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

N/A

Triggers:

Callback Function

Key	Type	Description
_status	Real
_data	ElementsScheduleEvent
_request	ElementsRequest

---

Back To Top

elements_schedule_get_schedule_event_by_name_or_id

Elements Operation: getScheduleEventByNameOrId

This function looks up a schedule by the passed in identifier.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback Function.

Syntax:

elements_schedule_get_schedule_event_by_name_or_id(_schedule_name_or_id, _schedule_event_id, _callback=undefined)

Argument	Type	Description
_schedule_name_or_id	String	The name or ID of the schedule.
_schedule_event_id	String	The event ID.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

N/A

Triggers:

Callback Function

Key	Type	Description
_status	Real
_data	ElementsScheduleEvent
_request	ElementsRequest

---

Back To Top

elements_schedule_update_schedule_event

Elements Operation: updateScheduleEvent

Supplying a schedule, this function will update the ScheduleEvent identified by the name or ID in the path with contents from the passed in request body.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback Function.

Syntax:

elements_schedule_update_schedule_event(_schedule_name_or_id, _schedule_event_id, _body=undefined, _callback=undefined)

Argument	Type	Description
_schedule_name_or_id	String	The name or ID of the schedule.
_schedule_event_id	String	The event ID.
_body	ElementsUpdateScheduleEventRequest	The body to be included in the HTTP request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

N/A

Triggers:

Callback Function

Key	Type	Description
_status	Real
_data	ElementsScheduleEvent
_request	ElementsRequest

---

Back To Top

elements_schedule_delete_schedule_event

Elements Operation: deleteScheduleEvent

This function deletes a schedule by the passed in identifier.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback Function.

Syntax:

elements_schedule_delete_schedule_event(_schedule_name_or_id, _schedule_event_id, _callback=undefined)

Argument	Type	Description
_schedule_name_or_id	String	The name or ID of the schedule.
_schedule_event_id	String	The event ID.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

N/A

Triggers:

Callback Function

Key	Type	Description
_status	Real
_data	Undefined
_request	ElementsRequest

---

Back To Top

elements_schedule_get_schedule_progresses

Elements Operation: getScheduleProgresses

This function fetches all current assignments to the currently logged-in profile.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback Function.

Syntax:

elements_schedule_get_schedule_progresses(_schedule_name_or_id, _offset=undefined, _count=undefined, _tags=undefined, _callback=undefined)

Argument	Type	Description
_schedule_name_or_id	String	The name or ID of the schedule.
_offset	Real	The offset of the first result to return in the page.
_count	Real	The number of results to return in the page.
_tags	Array of String	An array specifying tags (see tags Property).
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

N/A

Triggers:

Callback Function

Key	Type	Description
_status	Real
_data	ElementsPaginationProgress
_request	ElementsRequest

---

Back To Top

elements_schedule_get_schedules

Elements Operation: getSchedules

This function searches all schedules in the system and returns a number of matches against the given search filter, delimited by the offset and count.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback Function.

Syntax:

elements_schedule_get_schedules(_offset=undefined, _count=undefined, _tags=undefined, _search=undefined, _callback=undefined)

Argument	Type	Description
_offset	Real	The offset of the first result to return in the page.
_count	Real	The number of results to return in the page.
_tags	Array of String	An array specifying tags (see tags Property).
_search	String	The search filter to use.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

N/A

Triggers:

Callback Function

Key	Type	Description
_status	Real
_data	ElementsPaginationSchedule
_request	ElementsRequest

---

Back To Top

elements_schedule_create_schedule

Elements Operation: createSchedule

Supplying a schedule object, this function will create a new schedule with a newly assigned unique ID. The Schedule representation returned in the response body is a representation of the Schedule as persisted with a unique identifier assigned and with its fields properly normalized. The supplied schedule object submitted with the request must have a name property that is unique across all items.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback Function.

Syntax:

elements_schedule_create_schedule(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsCreateScheduleRequest	The body to be included in the HTTP request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

N/A

Triggers:

Callback Function

Key	Type	Description
_status	Real
_data	ElementsSchedule
_request	ElementsRequest

---

Back To Top

elements_schedule_get_schedule_by_name_or_id

Elements Operation: getScheduleByNameOrId

This function looks up a schedule by the passed in identifier.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback Function.

Syntax:

elements_schedule_get_schedule_by_name_or_id(_schedule_name_or_id, _callback=undefined)

Argument	Type	Description
_schedule_name_or_id	String	The name or ID of the schedule.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

N/A

Triggers:

Callback Function

Key	Type	Description
_status	Real
_data	ElementsSchedule
_request	ElementsRequest

---

Back To Top

elements_schedule_update_schedule

Elements Operation: updateSchedule

Supplying a schedule, this will update the Schedule identified by the name or ID in the path with contents from the passed in request body.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback Function.

Syntax:

elements_schedule_update_schedule(_schedule_name_or_id, _body=undefined, _callback=undefined)

Argument	Type	Description
_schedule_name_or_id	String	The name or ID of the schedule.
_body	ElementsUpdateScheduleRequest	The body to be included in the HTTP request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

N/A

Triggers:

Callback Function

Key	Type	Description
_status	Real
_data	ElementsSchedule
_request	ElementsRequest

---

Back To Top

elements_schedule_delete_schedule

Elements Operation: deleteSchedule

This function deletes a schedule by the passed in identifier.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback Function.

Syntax:

elements_schedule_delete_schedule(_schedule_name_or_id, _callback=undefined)

Argument	Type	Description
_schedule_name_or_id	String	The name or ID of the schedule.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

N/A

Triggers:

Callback Function

Key	Type	Description
_status	Real
_data	Undefined
_request	ElementsRequest