REST API Schedules

Schedules enables you to set up Transfers or Groups of Transfers to be run at certain intervals. Read more on how to use Schedules

Field	Type	Notes
id	string
type	string	always "schedules"
attributes
code	string	is automatically generated (dont set this field)
description	string	is generated on create if not set
transfer	string	set either transfercode OR groupcode
group	string	set either transfercode OR groupcode
interval	integer
interval_unit	string	"Minutes","Hours","Days","Weeks","Months"
status	string	"Ok","Processing","Error","Stopped"
error_handling	string	"Skip","Retry","Stop" (normally use "Skip")
last_datetime	datetime	UTC
next_datetime	datetime	UTC
error_interval	integer
error_interval_unit	string	"Minutes","Hours","Days","Weeks","Months"
notify_interval	integer
notify_interval_unit	string	"Minutes","Hours","Days","Weeks","Months"
notify_datetime	datetime	UTC
start_time	time	UTC
end_time	time	UTC
monday, tuesday, wednesday, thursday, friday, saturday, sunday	boolean	Run on these days

Query Parameter	Notes
id
groupcode	groupcode="Nameofgroupcode" -> ex. groupcode="TEST_22"
transfercode	transfercode="Nameoftransfercode" -> ex. transfercode="TRABC22"
schedulercode	schedulercode="Nameofschedulercode" -> ex. schedulercode="T_TRABC22"
search	search="searchterm" -> ex. search="TEST_22"
status	status="OK" , "Processing" , "Error" or "Stopped"
due	due="true"
overdue	overdue="true"
dueoroverdue	dueoroverdue="true"

REST API Schedules Get Schedules

REST API Schedules Start Schedules

REST API Schedules Stop Schedules

REST API Schedules Update Schedules

REST API Schedules Update Schedule to run now

REST API Schedules List Overdue Schedules

REST API Schedules Create Schedule

REST API Schedules Delete Schedule