GET api/Alerts/GetAlerts?Source={Source}&Reason={Reason}&StartDate={StartDate}&EndDate={EndDate}&skip={skip}&take={take}&reverse={reverse}&field={field}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| Source | globally unique identifier |
Required |
|
| Reason | globally unique identifier |
Required |
|
| StartDate | date |
Required |
|
| EndDate | date |
Required |
|
| skip | integer |
Required |
|
| take | integer |
Required |
|
| reverse | boolean |
Required |
|
| field | string |
Default value is None |
Body Parameters
None.
Response Information
Resource Description
PaginationOfAlertItem| Name | Description | Type | Additional information |
|---|---|---|---|
| IsAllSuccess | boolean |
None. |
|
| Items | Collection of AlertItem |
None. |
|
| UnPaginatedItems | Collection of AlertItem |
None. |
|
| FullCount | integer |
None. |
|
| Skip | integer |
None. |
|
| Take | integer |
None. |
|
| Properties | Dictionary of string [key] and string [value] |
None. |
Response Formats
application/json, text/json
Sample:
{
"IsAllSuccess": true,
"Items": [
{
"AlertID": 1,
"SourceID": "845b2c20-a529-441c-b3fa-eafdcd05829d",
"SourceType": "sample string 3",
"SourceOrigin": "sample string 4",
"ReasonID": "5f1fad46-eed9-438d-b258-6918f3d0e08e",
"ReasonType": "sample string 6",
"ReasonOrigin": "sample string 7",
"StartDate": "2026-04-07T20:11:30.5845947+10:00",
"EndDate": "2026-04-07T20:11:30.5845947+10:00",
"TimeZone": "sample string 8",
"Notes": "sample string 9",
"CreatedDate": "2026-04-07T20:11:30.5845947+10:00",
"DisplaySource": true,
"DisplayReason": true
},
{
"AlertID": 1,
"SourceID": "845b2c20-a529-441c-b3fa-eafdcd05829d",
"SourceType": "sample string 3",
"SourceOrigin": "sample string 4",
"ReasonID": "5f1fad46-eed9-438d-b258-6918f3d0e08e",
"ReasonType": "sample string 6",
"ReasonOrigin": "sample string 7",
"StartDate": "2026-04-07T20:11:30.5845947+10:00",
"EndDate": "2026-04-07T20:11:30.5845947+10:00",
"TimeZone": "sample string 8",
"Notes": "sample string 9",
"CreatedDate": "2026-04-07T20:11:30.5845947+10:00",
"DisplaySource": true,
"DisplayReason": true
}
],
"UnPaginatedItems": [
{
"AlertID": 1,
"SourceID": "845b2c20-a529-441c-b3fa-eafdcd05829d",
"SourceType": "sample string 3",
"SourceOrigin": "sample string 4",
"ReasonID": "5f1fad46-eed9-438d-b258-6918f3d0e08e",
"ReasonType": "sample string 6",
"ReasonOrigin": "sample string 7",
"StartDate": "2026-04-07T20:11:30.5845947+10:00",
"EndDate": "2026-04-07T20:11:30.5845947+10:00",
"TimeZone": "sample string 8",
"Notes": "sample string 9",
"CreatedDate": "2026-04-07T20:11:30.5845947+10:00",
"DisplaySource": true,
"DisplayReason": true
},
{
"AlertID": 1,
"SourceID": "845b2c20-a529-441c-b3fa-eafdcd05829d",
"SourceType": "sample string 3",
"SourceOrigin": "sample string 4",
"ReasonID": "5f1fad46-eed9-438d-b258-6918f3d0e08e",
"ReasonType": "sample string 6",
"ReasonOrigin": "sample string 7",
"StartDate": "2026-04-07T20:11:30.5845947+10:00",
"EndDate": "2026-04-07T20:11:30.5845947+10:00",
"TimeZone": "sample string 8",
"Notes": "sample string 9",
"CreatedDate": "2026-04-07T20:11:30.5845947+10:00",
"DisplaySource": true,
"DisplayReason": true
}
],
"FullCount": 2,
"Skip": 3,
"Take": 4,
"Properties": {
"sample string 1": "sample string 2",
"sample string 3": "sample string 4"
}
}
application/xml, text/xml
Sample:
<PaginationOfAlertItem9ExKlfMJ xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ConsoleAPI.Internal.Models.Common">
<FullCount>2</FullCount>
<IsAllSuccess>true</IsAllSuccess>
<Items xmlns:d2p1="http://schemas.datacontract.org/2004/07/ConsoleAPI.Internal.Models.Alerts">
<d2p1:AlertItem>
<d2p1:AlertID>1</d2p1:AlertID>
<d2p1:CreatedDate>2026-04-07T20:11:30.5845947+10:00</d2p1:CreatedDate>
<d2p1:DisplayReason>true</d2p1:DisplayReason>
<d2p1:DisplaySource>true</d2p1:DisplaySource>
<d2p1:EndDate>2026-04-07T20:11:30.5845947+10:00</d2p1:EndDate>
<d2p1:Notes>sample string 9</d2p1:Notes>
<d2p1:ReasonID>5f1fad46-eed9-438d-b258-6918f3d0e08e</d2p1:ReasonID>
<d2p1:ReasonOrigin>sample string 7</d2p1:ReasonOrigin>
<d2p1:ReasonType>sample string 6</d2p1:ReasonType>
<d2p1:SourceID>845b2c20-a529-441c-b3fa-eafdcd05829d</d2p1:SourceID>
<d2p1:SourceOrigin>sample string 4</d2p1:SourceOrigin>
<d2p1:SourceType>sample string 3</d2p1:SourceType>
<d2p1:StartDate>2026-04-07T20:11:30.5845947+10:00</d2p1:StartDate>
<d2p1:TimeZone>sample string 8</d2p1:TimeZone>
</d2p1:AlertItem>
<d2p1:AlertItem>
<d2p1:AlertID>1</d2p1:AlertID>
<d2p1:CreatedDate>2026-04-07T20:11:30.5845947+10:00</d2p1:CreatedDate>
<d2p1:DisplayReason>true</d2p1:DisplayReason>
<d2p1:DisplaySource>true</d2p1:DisplaySource>
<d2p1:EndDate>2026-04-07T20:11:30.5845947+10:00</d2p1:EndDate>
<d2p1:Notes>sample string 9</d2p1:Notes>
<d2p1:ReasonID>5f1fad46-eed9-438d-b258-6918f3d0e08e</d2p1:ReasonID>
<d2p1:ReasonOrigin>sample string 7</d2p1:ReasonOrigin>
<d2p1:ReasonType>sample string 6</d2p1:ReasonType>
<d2p1:SourceID>845b2c20-a529-441c-b3fa-eafdcd05829d</d2p1:SourceID>
<d2p1:SourceOrigin>sample string 4</d2p1:SourceOrigin>
<d2p1:SourceType>sample string 3</d2p1:SourceType>
<d2p1:StartDate>2026-04-07T20:11:30.5845947+10:00</d2p1:StartDate>
<d2p1:TimeZone>sample string 8</d2p1:TimeZone>
</d2p1:AlertItem>
</Items>
<Properties xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringstring>
<d2p1:Key>sample string 1</d2p1:Key>
<d2p1:Value>sample string 2</d2p1:Value>
</d2p1:KeyValueOfstringstring>
<d2p1:KeyValueOfstringstring>
<d2p1:Key>sample string 3</d2p1:Key>
<d2p1:Value>sample string 4</d2p1:Value>
</d2p1:KeyValueOfstringstring>
</Properties>
<Skip>3</Skip>
<Take>4</Take>
<UnPaginatedItems xmlns:d2p1="http://schemas.datacontract.org/2004/07/ConsoleAPI.Internal.Models.Alerts">
<d2p1:AlertItem>
<d2p1:AlertID>1</d2p1:AlertID>
<d2p1:CreatedDate>2026-04-07T20:11:30.5845947+10:00</d2p1:CreatedDate>
<d2p1:DisplayReason>true</d2p1:DisplayReason>
<d2p1:DisplaySource>true</d2p1:DisplaySource>
<d2p1:EndDate>2026-04-07T20:11:30.5845947+10:00</d2p1:EndDate>
<d2p1:Notes>sample string 9</d2p1:Notes>
<d2p1:ReasonID>5f1fad46-eed9-438d-b258-6918f3d0e08e</d2p1:ReasonID>
<d2p1:ReasonOrigin>sample string 7</d2p1:ReasonOrigin>
<d2p1:ReasonType>sample string 6</d2p1:ReasonType>
<d2p1:SourceID>845b2c20-a529-441c-b3fa-eafdcd05829d</d2p1:SourceID>
<d2p1:SourceOrigin>sample string 4</d2p1:SourceOrigin>
<d2p1:SourceType>sample string 3</d2p1:SourceType>
<d2p1:StartDate>2026-04-07T20:11:30.5845947+10:00</d2p1:StartDate>
<d2p1:TimeZone>sample string 8</d2p1:TimeZone>
</d2p1:AlertItem>
<d2p1:AlertItem>
<d2p1:AlertID>1</d2p1:AlertID>
<d2p1:CreatedDate>2026-04-07T20:11:30.5845947+10:00</d2p1:CreatedDate>
<d2p1:DisplayReason>true</d2p1:DisplayReason>
<d2p1:DisplaySource>true</d2p1:DisplaySource>
<d2p1:EndDate>2026-04-07T20:11:30.5845947+10:00</d2p1:EndDate>
<d2p1:Notes>sample string 9</d2p1:Notes>
<d2p1:ReasonID>5f1fad46-eed9-438d-b258-6918f3d0e08e</d2p1:ReasonID>
<d2p1:ReasonOrigin>sample string 7</d2p1:ReasonOrigin>
<d2p1:ReasonType>sample string 6</d2p1:ReasonType>
<d2p1:SourceID>845b2c20-a529-441c-b3fa-eafdcd05829d</d2p1:SourceID>
<d2p1:SourceOrigin>sample string 4</d2p1:SourceOrigin>
<d2p1:SourceType>sample string 3</d2p1:SourceType>
<d2p1:StartDate>2026-04-07T20:11:30.5845947+10:00</d2p1:StartDate>
<d2p1:TimeZone>sample string 8</d2p1:TimeZone>
</d2p1:AlertItem>
</UnPaginatedItems>
</PaginationOfAlertItem9ExKlfMJ>