PUT api/reportserver/v2/dataalerts
Updates a data alert.
Request Information
URI Parameters
None.
Body Parameters
Data alert model.
| Name | Description | Type | Additional information |
|---|---|---|---|
| Rules |
Specifies the data alert rules. | Collection of DataAlertRule |
Required |
| 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
{
"Rules": [
{
"Index": 1790,
"DataItemName": "Marketing Reports",
"Clauses": [
{
"Column": "OrderDate",
"Operator": "is",
"Value": "100"
},
{
"Column": "CustomerName",
"Operator": "is",
"Value": "100"
}
]
},
{
"Index": 1796,
"DataItemName": "Financial Reports",
"Clauses": [
{
"Column": "CustomerName",
"Operator": "is",
"Value": "100"
},
{
"Column": "OrderDate",
"Operator": "is",
"Value": "100"
}
]
}
],
"Id": "24135a3fcba",
"UserId": "bf531b8f655a4a48ad7d52a031a87f7b",
"Name": "Sales Reports",
"Enabled": true,
"Reports": [
{
"ReportId": "27877bd160e",
"DocumentFormat": "Pdf",
"Parameters": {
"Region": "North America",
"CustomerId": 12345
}
},
{
"ReportId": "4d7983b5332",
"DocumentFormat": "Pdf",
"Parameters": {
"Region": "North America",
"CustomerId": 12345
}
}
],
"StartDate": "2026-11-11T15:21:26.3786826+00:00",
"StartDateUtc": "2026-11-11T15:21:26.3786826Z",
"BaseUtcOffset": 1816.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": [
"alex.johnson@example.com",
"jane.doe@example.com"
],
"SubscriberIds": [
"a837bb11da4b49639d7ccab3f685991d",
"8ff7c7c876394acb98f2eadd4cd7d2eb"
]
}
Response Information
Resource Description
| Name | Description | Type | Additional information |
|---|---|---|---|
| Rules |
Specifies the data alert rules. | Collection of DataAlertRule |
Required |
| 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
{
"Rules": [
{
"Index": 1790,
"DataItemName": "Marketing Reports",
"Clauses": [
{
"Column": "OrderDate",
"Operator": "is",
"Value": "100"
},
{
"Column": "CustomerName",
"Operator": "is",
"Value": "100"
}
]
},
{
"Index": 1796,
"DataItemName": "Financial Reports",
"Clauses": [
{
"Column": "CustomerName",
"Operator": "is",
"Value": "100"
},
{
"Column": "OrderDate",
"Operator": "is",
"Value": "100"
}
]
}
],
"Id": "24135a3fcba",
"UserId": "bf531b8f655a4a48ad7d52a031a87f7b",
"Name": "Sales Reports",
"Enabled": true,
"Reports": [
{
"ReportId": "27877bd160e",
"DocumentFormat": "Pdf",
"Parameters": {
"Region": "North America",
"CustomerId": 12345
}
},
{
"ReportId": "4d7983b5332",
"DocumentFormat": "Pdf",
"Parameters": {
"Region": "North America",
"CustomerId": 12345
}
}
],
"StartDate": "2026-11-11T15:21:26.3786826+00:00",
"StartDateUtc": "2026-11-11T15:21:26.3786826Z",
"BaseUtcOffset": 1816.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": [
"alex.johnson@example.com",
"jane.doe@example.com"
],
"SubscriberIds": [
"a837bb11da4b49639d7ccab3f685991d",
"8ff7c7c876394acb98f2eadd4cd7d2eb"
]
}