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": "c750588f607",
"UserId": "64337476f22d4eb4a243dc6b3d3ebf5c",
"Name": "Financial Reports",
"Enabled": true,
"Reports": [
{
"ReportId": "9bdd15e1beb",
"DocumentFormat": "Pdf",
"Parameters": {
"CustomerId": 12345,
"IsActive": true
}
},
{
"ReportId": "ecf4f42fa1f",
"DocumentFormat": "Pdf",
"Parameters": {
"CustomerId": 12345,
"IsActive": true
}
}
],
"StartDate": "2026-10-08T14:36:35.2965791+00:00",
"StartDateUtc": "2026-10-08T14:36:35.2965791Z",
"BaseUtcOffset": 1637.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": [
"jane.doe@example.com",
"john.smith@example.com"
],
"SubscriberIds": [
"9d45b4d035904eb1a451b92d0347fe20",
"feb9d0dead82413d9ae51f776f063b8e"
]
},
{
"Id": "b36b45dc9fc",
"UserId": "b281b6c5faa348ec8e9ca6b6b9456e35",
"Name": "HR Reports",
"Enabled": true,
"Reports": [
{
"ReportId": "9bced31a2f0",
"DocumentFormat": "Pdf",
"Parameters": {
"IsActive": true,
"OrderDate": "2024-01-15"
}
},
{
"ReportId": "294fedd8744",
"DocumentFormat": "Pdf",
"Parameters": {
"IsActive": true,
"OrderDate": "2024-01-15"
}
}
],
"StartDate": "2026-10-08T14:36:35.2965791+00:00",
"StartDateUtc": "2026-10-08T14:36:35.2965791Z",
"BaseUtcOffset": 1658.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": [
"eab53ca57e56465d850695801e5a4d7a",
"2532455494a64699897a59b2a85f5c66"
]
}
]