GET api/reportserver/v2/scheduledtasks
Returns a collection of all scheduled tasks.
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
Collection of ScheduledTask
| 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. |
Response Formats
application/json, text/json
[
{
"Id": "b648b519004",
"UserId": "cfca7a08c2744382a7e51ace2f2be764",
"Name": "HR Reports",
"Enabled": true,
"Reports": [
{
"ReportId": "845faff0008",
"DocumentFormat": "Pdf",
"Parameters": {
"IsActive": true,
"OrderDate": "2024-01-15"
}
},
{
"ReportId": "5857a805c0c",
"DocumentFormat": "Pdf",
"Parameters": {
"IsActive": true,
"OrderDate": "2024-01-15"
}
}
],
"StartDate": "2026-11-11T15:21:26.3786826+00:00",
"StartDateUtc": "2026-11-11T15:21:26.3786826Z",
"BaseUtcOffset": 1762.1,
"RecurrenceRule": null,
"LocalUsersMailTemplate": {
"Subject": "Your scheduled report is ready",
"Body": "The report you subscribed to has been generated and is attached to this email."
},
"ExternalUsersMailTemplate": {
"Subject": "Your scheduled report is ready",
"Body": "The report you subscribed to has been generated and is attached to this email."
},
"ExternalEmails": [
"john.smith@example.com",
"maria.garcia@example.com"
],
"SubscriberIds": [
"cc7a17d1b6a644329394e35db5344da2",
"0c5aedd1775c4506a67bf78fc6381f49"
]
},
{
"Id": "6520391e899",
"UserId": "60aa91b8f77946e7bd004c3771ad3da8",
"Name": "Marketing Reports",
"Enabled": true,
"Reports": [
{
"ReportId": "2eb56a5705d",
"DocumentFormat": "Pdf",
"Parameters": {
"OrderDate": "2024-01-15",
"Region": "North America"
}
},
{
"ReportId": "dc975d5a211",
"DocumentFormat": "Pdf",
"Parameters": {
"OrderDate": "2024-01-15",
"Region": "North America"
}
}
],
"StartDate": "2026-11-11T15:21:26.3786826+00:00",
"StartDateUtc": "2026-11-11T15:21:26.3786826Z",
"BaseUtcOffset": 1783.1,
"RecurrenceRule": null,
"LocalUsersMailTemplate": {
"Subject": "Your scheduled report is ready",
"Body": "The report you subscribed to has been generated and is attached to this email."
},
"ExternalUsersMailTemplate": {
"Subject": "Your scheduled report is ready",
"Body": "The report you subscribed to has been generated and is attached to this email."
},
"ExternalEmails": [
"maria.garcia@example.com",
"alex.johnson@example.com"
],
"SubscriberIds": [
"b76322d1b95f47ba9978f9b76a8cc017",
"419ad40ab01c4aa9b78ab00867452cc5"
]
}
]