PATCH api/v1/alerts/{id}
Modify existing alert.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id |
Id of the alert to update. |
globally unique identifier |
Required |
Body Parameters
UpdateAlertViewModelName | Description | Type | Additional information |
---|---|---|---|
Cleared |
Mark the alert as cleared. Note that it is not possible to unclear an alert. |
boolean |
None. |
ActionRequired |
Mark the alert as Action Required. This toggles the action required flag so it can be cleared once action has been taken. |
boolean |
None. |
Request Formats
application/json, text/json, application/senml+json
{ "Cleared": true, "ActionRequired": true, "AssignTo": "da4e5c9e-64e0-4a18-babb-cebc4669da38" }
application/xml, text/xml
<UpdateAlertViewModel 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> <AssignTo>da4e5c9e-64e0-4a18-babb-cebc4669da38</AssignTo> <Cleared>true</Cleared> </UpdateAlertViewModel>
application/x-www-form-urlencoded
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
{ "Id": "807f083c-4fd9-442d-b48b-6018f4443b35", "Url": "sample string 2", "Message": "sample string 3", "ActionRequired": true, "Level": "Warning", "Distribution": "All", "Cleared": true, "DateAdded": "2024-09-07T04:51:15.2464998+00:00", "LastUpdated": "2024-09-07T04:51:15.2464998+00:00", "RaisedById": "b1303e47-bf35-41cd-abe4-cd2f3e288acb", "RaisedByUser": { "Id": "749e95db-5a7b-4b55-9105-f8d6192eaab2", "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": "1869f9de-4180-4945-a8ec-93e350d45def", "RaisedByUserId": "87f4d735-282c-4946-98be-04ae3716d76a", "PostedOn": "2024-09-07T04:51:15.2464998+00:00", "Tags": [ "sample string 1", "sample string 2" ], "Private": true }
application/xml, text/xml
<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>1869f9de-4180-4945-a8ec-93e350d45def</AssignedToUserId> <Cleared>true</Cleared> <DateAdded>2024-09-07T04:51:15.2464998+00:00</DateAdded> <Distribution>All</Distribution> <Id>807f083c-4fd9-442d-b48b-6018f4443b35</Id> <LastUpdated>2024-09-07T04:51:15.2464998+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-09-07T04:51:15.2464998+00:00</PostedOn> <Private>true</Private> <RaisedById>b1303e47-bf35-41cd-abe4-cd2f3e288acb</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>749e95db-5a7b-4b55-9105-f8d6192eaab2</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>87f4d735-282c-4946-98be-04ae3716d76a</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>