ScheduledTask
Provides information about a scheduled task.
| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
Provides the scheduled task identifier. |
string |
Required |
| UserId |
Specifies the ID of the user who has created the scheduled task. |
string |
None. |
| Name |
Gets or sets the scheduled task name. |
string |
Required |
| Enabled |
Gets or sets whether the scheduled task is either enabled or disabled. |
boolean |
None. |
| Reports |
Gets or sets the reports which are rendered by the scheduled task. |
Collection of ScheduledTaskReport |
Required |
| StartDate |
Obsolete since R2 2020. Use StartDateUtc property instead. Gets or sets the start date of the scheduled task in the author local time zone. |
date |
None. |
| StartDateUtc |
Gets or sets the start date of the scheduled task in UTC. |
date |
None. |
| BaseUtcOffset |
Gets or sets the UTC offset to the local timezone of the scheduled task author. Used for the mail templates date time type tokens. |
decimal number |
None. |
| RecurrenceRule |
Gets or sets recurrence rule for the scheduled task. |
RecurrenceRule |
None. |
| LocalUsersMailTemplate |
Gets or sets the mail template for local users. Set to null to use the default template. |
TaskMailTemplateModel |
None. |
| ExternalUsersMailTemplate |
Gets or sets the mail template for external users. Set to null to use the default template. |
TaskMailTemplateModel |
None. |
| ExternalEmails |
Gets or sets the emails of the external users to whom the report document should be sent. |
Collection of string |
None. |
| SubscriberIds |
Provides a list of IDs of the users subscribed to the data alert. |
Collection of string |
None. |