PUT 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

UpdateAlertViewModel

Name	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

Sample:

{
  "Cleared": true,
  "ActionRequired": true,
  "AssignTo": "dea9b541-54da-4018-9cac-88165c9d0005"
}

application/xml, text/xml

Sample:

<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>dea9b541-54da-4018-9cac-88165c9d0005</AssignTo>
  <Cleared>true</Cleared>
</UpdateAlertViewModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

AlertViewModel

Name	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": "70bc095c-73e4-4172-bbdf-f9362286ce0e",
  "Url": "sample string 2",
  "Message": "sample string 3",
  "ActionRequired": true,
  "Level": "Warning",
  "Distribution": "All",
  "Cleared": true,
  "DateAdded": "2024-11-21T07:09:21.7134668+00:00",
  "LastUpdated": "2024-11-21T07:09:21.7134668+00:00",
  "RaisedById": "14e84f55-d60c-46d9-a9d2-6eaf56518b64",
  "RaisedByUser": {
    "Id": "3d2599a4-9346-4056-bd86-190246f6e263",
    "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": "680f1c94-a068-4b5e-810b-ec4f89bd5d51",
  "RaisedByUserId": "6b7df5b1-39ea-454d-8aaa-a8adbab942ea",
  "PostedOn": "2024-11-21T07:09:21.7134668+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>680f1c94-a068-4b5e-810b-ec4f89bd5d51</AssignedToUserId>
  <Cleared>true</Cleared>
  <DateAdded>2024-11-21T07:09:21.7134668+00:00</DateAdded>
  <Distribution>All</Distribution>
  <Id>70bc095c-73e4-4172-bbdf-f9362286ce0e</Id>
  <LastUpdated>2024-11-21T07:09:21.7134668+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-11-21T07:09:21.7134668+00:00</PostedOn>
  <Private>true</Private>
  <RaisedById>14e84f55-d60c-46d9-a9d2-6eaf56518b64</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>3d2599a4-9346-4056-bd86-190246f6e263</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>6b7df5b1-39ea-454d-8aaa-a8adbab942ea</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>