POST api/v1/alerts
Raise a new alert.
Request Information
URI Parameters
None.
Body Parameters
RaiseAlertViewModelName | Description | Type | Additional information |
---|---|---|---|
Message | string |
None. |
|
Level | AlertLevel |
None. |
|
Distribution | DistributionLevel |
None. |
|
UserId |
If the distribution is user, then we need to user Id to assign the alert to. |
globally unique identifier |
None. |
ActionRequired | boolean |
None. |
Request Formats
application/json, text/json, application/senml+json
Sample:
{ "Message": "sample string 1", "Level": 0, "Distribution": 0, "UserId": "b11a3da9-57e2-4b3b-af99-76c50e9b73a4", "ActionRequired": true, "Tags": [ "sample string 1", "sample string 2" ], "Lite": true }
application/xml, text/xml
Sample:
<RaiseAlertViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Alerts"> <ActionRequired>true</ActionRequired> <Distribution>All</Distribution> <Level>Warning</Level> <Lite>true</Lite> <Message>sample string 1</Message> <Tags xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </Tags> <UserId>b11a3da9-57e2-4b3b-af99-76c50e9b73a4</UserId> </RaiseAlertViewModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
AlertViewModelName | Description | Type | Additional information |
---|---|---|---|
Id |
Unique identifier of the alert. |
globally unique identifier |
None. |
Url | string |
None. |
|
Message |
The alert message. |
string |
None. |
ActionRequired |
If action is required. |
boolean |
None. |
Level |
The level of the alert. |
AlertLevel |
None. |
Distribution |
Who the alert should be distributed to. |
DistributionLevel |
None. |
Cleared |
If the alert has been cleared. |
boolean |
None. |
DateAdded |
When the alert was raised/added to the system. |
date |
None. |
LastUpdated |
When the alert was last updated. |
date |
None. |
RaisedById |
Here to help the population of RaisedBy |
globally unique identifier |
None. |
RaisedByUser |
Model of the user who raised the alert. |
UserDto |
None. |
MoreLink |
Additional links. |
LinkDto |
None. |
Links | Collection of LinkDto |
None. |
|
AssignedToUserId | globally unique identifier |
None. |
|
RaisedByUserId | globally unique identifier |
None. |
|
PostedOn | date |
None. |
|
Tags | Collection of string |
None. |
|
Private | boolean |
None. |
Response Formats
application/json, text/json, application/senml+json
Sample:
{ "Id": "b398e59c-ec7b-4970-bfd0-f094918eb7d5", "Url": "sample string 2", "Message": "sample string 3", "ActionRequired": true, "Level": "Warning", "Distribution": "All", "Cleared": true, "DateAdded": "2024-12-01T19:55:25.8731036+00:00", "LastUpdated": "2024-12-01T19:55:25.8731036+00:00", "RaisedById": "77948f88-d54f-4e8c-a426-c2b682ad691b", "RaisedByUser": { "Id": "02da6876-3235-49d0-a1a6-bb5aec732b74", "Url": "sample string 2", "AccountId": "sample string 3", "Name": "sample string 4", "UserName": "sample string 5", "FullUserName": "sample string 6", "DisplayName": "sample string 7", "Avatar": { "Href": "sample string 1", "Rel": "sample string 2", "Action": "sample string 3" }, "TimeLine": { "Href": "sample string 1", "Rel": "sample string 2", "Action": "sample string 3" }, "Profile": { "Href": "sample string 1", "Rel": "sample string 2", "Action": "sample string 3" }, "Tags": [ "sample string 1", "sample string 2" ], "Links": [ { "Href": "sample string 1", "Rel": "sample string 2", "Action": "sample string 3" }, { "Href": "sample string 1", "Rel": "sample string 2", "Action": "sample string 3" } ], "Actions": [ { "Href": "sample string 1", "Rel": "sample string 2", "Action": "sample string 3" }, { "Href": "sample string 1", "Rel": "sample string 2", "Action": "sample string 3" } ] }, "MoreLink": { "Href": "sample string 1", "Rel": "sample string 2", "Action": "sample string 3" }, "Links": [ { "Href": "sample string 1", "Rel": "sample string 2", "Action": "sample string 3" }, { "Href": "sample string 1", "Rel": "sample string 2", "Action": "sample string 3" } ], "AssignedToUserId": "9df2c3c8-5d63-4e62-b98b-17b284dd4f18", "RaisedByUserId": "0ddf4ca6-a7c9-4c57-9e0b-82e56e002722", "PostedOn": "2024-12-01T19:55:25.8731036+00:00", "Tags": [ "sample string 1", "sample string 2" ], "Private": true }
application/xml, text/xml
Sample:
<AlertViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Alerts"> <ActionRequired>true</ActionRequired> <AssignedToUserId>9df2c3c8-5d63-4e62-b98b-17b284dd4f18</AssignedToUserId> <Cleared>true</Cleared> <DateAdded>2024-12-01T19:55:25.8731036+00:00</DateAdded> <Distribution>All</Distribution> <Id>b398e59c-ec7b-4970-bfd0-f094918eb7d5</Id> <LastUpdated>2024-12-01T19:55:25.8731036+00:00</LastUpdated> <Level>Warning</Level> <Links xmlns:d2p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Shared"> <d2p1:LinkViewModel> <d2p1:Action>sample string 3</d2p1:Action> <d2p1:Href>sample string 1</d2p1:Href> <d2p1:Rel>sample string 2</d2p1:Rel> </d2p1:LinkViewModel> <d2p1:LinkViewModel> <d2p1:Action>sample string 3</d2p1:Action> <d2p1:Href>sample string 1</d2p1:Href> <d2p1:Rel>sample string 2</d2p1:Rel> </d2p1:LinkViewModel> </Links> <Message>sample string 3</Message> <MoreLink xmlns:d2p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Shared"> <d2p1:Action>sample string 3</d2p1:Action> <d2p1:Href>sample string 1</d2p1:Href> <d2p1:Rel>sample string 2</d2p1:Rel> </MoreLink> <PostedOn>2024-12-01T19:55:25.8731036+00:00</PostedOn> <Private>true</Private> <RaisedById>77948f88-d54f-4e8c-a426-c2b682ad691b</RaisedById> <RaisedByUser xmlns:d2p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Shared"> <d2p1:AccountId>sample string 3</d2p1:AccountId> <d2p1:Actions> <d2p1:LinkViewModel> <d2p1:Action>sample string 3</d2p1:Action> <d2p1:Href>sample string 1</d2p1:Href> <d2p1:Rel>sample string 2</d2p1:Rel> </d2p1:LinkViewModel> <d2p1:LinkViewModel> <d2p1:Action>sample string 3</d2p1:Action> <d2p1:Href>sample string 1</d2p1:Href> <d2p1:Rel>sample string 2</d2p1:Rel> </d2p1:LinkViewModel> </d2p1:Actions> <d2p1:Avatar> <d2p1:Action>sample string 3</d2p1:Action> <d2p1:Href>sample string 1</d2p1:Href> <d2p1:Rel>sample string 2</d2p1:Rel> </d2p1:Avatar> <d2p1:DisplayName>sample string 7</d2p1:DisplayName> <d2p1:FullUserName>sample string 6</d2p1:FullUserName> <d2p1:Id>02da6876-3235-49d0-a1a6-bb5aec732b74</d2p1:Id> <d2p1:Links> <d2p1:LinkViewModel> <d2p1:Action>sample string 3</d2p1:Action> <d2p1:Href>sample string 1</d2p1:Href> <d2p1:Rel>sample string 2</d2p1:Rel> </d2p1:LinkViewModel> <d2p1:LinkViewModel> <d2p1:Action>sample string 3</d2p1:Action> <d2p1:Href>sample string 1</d2p1:Href> <d2p1:Rel>sample string 2</d2p1:Rel> </d2p1:LinkViewModel> </d2p1:Links> <d2p1:Name>sample string 4</d2p1:Name> <d2p1:Profile> <d2p1:Action>sample string 3</d2p1:Action> <d2p1:Href>sample string 1</d2p1:Href> <d2p1:Rel>sample string 2</d2p1:Rel> </d2p1:Profile> <d2p1:Tags xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 1</d3p1:string> <d3p1:string>sample string 2</d3p1:string> </d2p1:Tags> <d2p1:TimeLine> <d2p1:Action>sample string 3</d2p1:Action> <d2p1:Href>sample string 1</d2p1:Href> <d2p1:Rel>sample string 2</d2p1:Rel> </d2p1:TimeLine> <d2p1:Url>sample string 2</d2p1:Url> <d2p1:UserName>sample string 5</d2p1:UserName> </RaisedByUser> <RaisedByUserId>0ddf4ca6-a7c9-4c57-9e0b-82e56e002722</RaisedByUserId> <Tags xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </Tags> <Url>sample string 2</Url> </AlertViewModel>