SiteScheduledJobs.getSchedule (Method)
Retrieves information about the specified scheduled job's schedule and server on which it runs.
Returns:
ScheduledJobs_GetSchedule_Result (struct)
Each row of the returned query results has the following fields:
Field Name | Type | Description |
---|---|---|
EndDate | Date_EmptyString | The date the job stops running or an empty string. |
EndTime | Time_EmptyString | The time the job ends or an empty string. |
Frequency | ScheduledJobFrequency | The frequency type (One Time, Recurring Daily, Recurring Weekly, Recurring Monthly, Daily Every). |
IntervalSeconds | NonNegativeInteger | When frequency is Daily Every, the interval of seconds between jobs, otherwise 0. |
StartDate | Date | The date the job starts running. |
StartTime | Time | The time the job starts. |
Arguments:
Name | Type | Required | Description |
---|---|---|---|
scheduledJobID | SiteScheduledJobID | Required | The unique ID of the scheduled job. |
Context:
License Requirements | (none) |
Permission Requirements | hybrid:JobOwnerOrSiteAdmin |
Deny Context | ClusterROPS |
Require Context | (none) |
Author Lock | (not required) |
Transaction Logging | Transaction logging is disabled for this method |
Customization | Customization is not supported for this method. |
Error Codes:
None
Notes:
None