SiteScheduledJobs.saveSchedule (Method)
Saves the information about the specified scheduled job's schedule and server on which it runs.
Returns:
Void
Arguments:
Name | Type | Required | Description |
---|---|---|---|
scheduledJobID | SiteScheduledJobID | Required | The unique ID of the scheduled job. |
startDate | Date | Required | The date the job starts running. |
startTime | Time | Required | The time the job starts. |
frequency | ScheduledJobFrequency | Required | The frequency type (One Time, Recurring Daily, Recurring Weekly, Recurring Monthly, Daily Every). |
intervalSeconds | NonNegativeInteger | Optional. Defaults to '0'. | When frequency is Daily Every, the interval of seconds between jobs, otherwise 0. |
endDate | Date_EmptyString | Optional. Defaults to an empty string. | The date the job stops running or an empty string. |
endTime | Time_EmptyString | Optional. Defaults to '23:59:59'. | The time the job ends or an empty string. |
Context:
License Requirements | (none) |
Permission Requirements | hybrid:JobOwnerOrSiteAdmin |
Deny Context | ClusterROPS |
Require Context | (none) |
Author Lock | (not required) |
Transaction Logging | If transaction logging is enabled at the site level, calls to this method will be logged |
Customization | Customization is not supported for this method. |
Error Codes:
Code | Error Message |
---|---|
39002 | Interval cannot be less than one minute if the frequency is 'Daily Every'. |
Notes:
None