Skip to main content

Scheduleinfo

Properties

NameTypeDescriptionNotes
scheduleTaskId(optional) numberThe unique identifier for the scheduled task.[default to undefined]
scheduleTaskName(optional) stringThe display name of the scheduled task.[default to undefined]
taskTypeName(optional) stringThe type or category of the scheduled task.[default to undefined]
interval(optional) numberThe interval depends on the chosen schedule cycle (scheduleType), i.e. if the schedule is daily, the interval will represent the days between executions.[default to undefined]
scheduleType(optional) stringThe scheduling type, such as "Daily", "Weekly", or "Manual" etc.[default to undefined]
active(optional) booleanIndicates whether the scheduled task is currently active.[default to false]
startTime(optional) numberThe start time for the scheduled task, represented as epoch seconds.[default to undefined]
endTime(optional) numberThe end time for the scheduled task, represented as epoch seconds.[default to undefined]
daysOfWeek(optional) Array<string>A list of days of the week when the task should run (e.g., "Monday", "Wednesday").[default to undefined]
runAfterScheduleTaskId(optional) numberThe ID of another scheduled task that triggers this scheduled task upon its completion.[default to undefined]
runAfterScheduleTaskName(optional) stringThe name of the scheduled task that must complete before this task runs.[default to undefined]
applicationId(optional) numberThe unique identifier of the application associated with the scheduled task.[default to undefined]
createdByDisplayName(optional) stringThe display name of the user who created the scheduled task.[default to undefined]
nextRun(optional) numberThe next scheduled run time for the task, represented as epoch seconds.[default to undefined]
lastRun(optional) numberThe last run time of the task, represented as epoch seconds.[default to undefined]