POST api/reportserver/dataalerts
Creates a new data alert.
Request Information
URI Parameters
None.
Body Parameters
Data alert model.
| Name | Description | Type | Additional information |
|---|---|---|---|
| Rules |
Specifies the rules for the data alert. | Collection of DataAlertRuleV1 |
Required |
| Name |
Specifies the scheduled task name. | string |
Required |
| Enabled |
Specifies whether the scheduled task is either enabled or disabled. | boolean |
None. |
| ReportId |
Obsolete since R3 2018. Use Reports property instead. | string |
Required |
| DocumentFormat |
Obsolete since R3 2018. Use Reports property instead. | string |
Required |
| Parameters |
Obsolete since R3 2018. Use Reports property instead. | Dictionary of string [key] and Object [value] |
None. |
| StartDate |
Specifies the start date of the scheduled task. | date |
None. |
| RecurrenceRule |
Specifies recurrence rule for the scheduled task. | RecurrenceRule |
None. |
| MailSubject |
Specifies the mail template subject. | string |
None. |
| MailBody |
Specifies the mail template body. | string |
None. |
| ExternalEmails |
Specifies 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": [
{
"DataItemName": "sample string 1",
"Clauses": [
{
"Column": "sample string 1",
"Operator": "is",
"Value": "sample string 2"
},
{
"Column": "sample string 1",
"Operator": "is",
"Value": "sample string 2"
}
]
},
{
"DataItemName": "sample string 1",
"Clauses": [
{
"Column": "sample string 1",
"Operator": "is",
"Value": "sample string 2"
},
{
"Column": "sample string 1",
"Operator": "is",
"Value": "sample string 2"
}
]
}
],
"Name": "sample string 1",
"Enabled": true,
"ReportId": "sample string 3",
"DocumentFormat": "sample string 4",
"Parameters": {
"sample string 1": {},
"sample string 3": {}
},
"StartDate": "2026-02-20T15:46:23.1444181+00:00",
"RecurrenceRule": null,
"MailSubject": "sample string 6",
"MailBody": "sample string 7",
"ExternalEmails": [
"sample string 1",
"sample string 2"
],
"SubscriberIds": [
"sample string 1",
"sample string 2"
]
}
Response Information
Resource Description
The ID of the new data alert.
string
| Name | Description | Type | Additional information |
|---|
Response Formats
application/json, text/json
"sample string 1"