PUT api/reportserver/v2/scheduledtasks
Updates a scheduled task.
Request Information
URI Parameters
None.
Body Parameters
Scheduled task model.
| 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. |
Request body formats
application/json, text/json
{
"Id": "2e5884f62ed",
"UserId": "8ca92edf5b114683b7838e29514e7f89",
"Name": "Marketing Reports",
"Enabled": true,
"Reports": [
{
"ReportId": "b4ef456a101",
"DocumentFormat": "Pdf",
"Parameters": {
"OrderDate": "2024-01-15",
"Region": "North America"
}
},
{
"ReportId": "e441aa14755",
"DocumentFormat": "Pdf",
"Parameters": {
"OrderDate": "2024-01-15",
"Region": "North America"
}
}
],
"StartDate": "2026-11-11T15:21:26.5037057+00:00",
"StartDateUtc": "2026-11-11T15:21:26.5037057Z",
"BaseUtcOffset": 1931.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": [
"41a35f5816eb4bc191dd7513144c418f",
"3522cdf50e9e441a857e736753dcd583"
]
}
Response Information
Resource Description
| 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": "2e5884f62ed",
"UserId": "8ca92edf5b114683b7838e29514e7f89",
"Name": "Marketing Reports",
"Enabled": true,
"Reports": [
{
"ReportId": "b4ef456a101",
"DocumentFormat": "Pdf",
"Parameters": {
"OrderDate": "2024-01-15",
"Region": "North America"
}
},
{
"ReportId": "e441aa14755",
"DocumentFormat": "Pdf",
"Parameters": {
"OrderDate": "2024-01-15",
"Region": "North America"
}
}
],
"StartDate": "2026-11-11T15:21:26.5037057+00:00",
"StartDateUtc": "2026-11-11T15:21:26.5037057Z",
"BaseUtcOffset": 1931.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": [
"41a35f5816eb4bc191dd7513144c418f",
"3522cdf50e9e441a857e736753dcd583"
]
}