GET api/reportserver/v3/scheduled-tasks
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
[
{
"Id": "4cdbf3b93a3",
"UserId": "8867d60c0f2140008d29e1243d673ed1",
"Name": "Financial Reports",
"Enabled": true,
"Reports": [
{
"ReportId": "ab31b63c607",
"DocumentFormat": "Pdf",
"Parameters": {
"CustomerId": 12345,
"IsActive": true
}
},
{
"ReportId": "2c37c22476b",
"DocumentFormat": "Pdf",
"Parameters": {
"CustomerId": 12345,
"IsActive": true
}
}
],
"StartDate": "2026-10-08T14:36:45.3675493+00:00",
"StartDateUtc": "2026-10-08T14:36:45.3675493Z",
"BaseUtcOffset": 385.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": [
"ed39e2da57db44888f8c241f9230616a",
"5ceff00ec82c4394b5102c218e479a83"
]
},
{
"Id": "dc2bc7196c8",
"UserId": "4155d2ce139d45928401e3ea942e75ad",
"Name": "HR Reports",
"Enabled": true,
"Reports": [
{
"ReportId": "10d0c78d1ec",
"DocumentFormat": "Pdf",
"Parameters": {
"IsActive": true,
"OrderDate": "2024-01-15"
}
},
{
"ReportId": "aa07e7b1850",
"DocumentFormat": "Pdf",
"Parameters": {
"IsActive": true,
"OrderDate": "2024-01-15"
}
}
],
"StartDate": "2026-10-08T14:36:45.3681342+00:00",
"StartDateUtc": "2026-10-08T14:36:45.3681342Z",
"BaseUtcOffset": 406.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": [
"a989ad406c40459fac739e5a2387b420",
"897cf4629b994215ac064601beefd5d9"
]
}
]