PATCH api/v1/alerts/{id}

Modify existing alert.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Id of the alert to update.

globally unique identifier

Required

Body Parameters

UpdateAlertViewModel
NameDescriptionTypeAdditional 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": "df56cbc5-6a3a-4f13-94bc-cfac8fe07d43"
}

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>df56cbc5-6a3a-4f13-94bc-cfac8fe07d43</AssignTo>
  <Cleared>true</Cleared>
</UpdateAlertViewModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

AlertViewModel
NameDescriptionTypeAdditional 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": "678c2d07-152a-4b53-bee5-0e9723625037",
  "Url": "sample string 2",
  "Message": "sample string 3",
  "ActionRequired": true,
  "Level": "Warning",
  "Distribution": "All",
  "Cleared": true,
  "DateAdded": "2017-08-19T08:39:54.714978+00:00",
  "LastUpdated": "2017-08-19T08:39:54.714978+00:00",
  "RaisedById": "4d7da2c8-d5bf-4979-9fa9-ef660ff63792",
  "RaisedByUser": {
    "Id": "eefcbfdf-8c0b-4812-b21c-d0c7c2283b40",
    "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": "875b8bc9-1feb-4375-807a-e58a9f57e6a1",
  "RaisedByUserId": "6151d9b9-afdd-465f-8af0-a7a70426542c",
  "PostedOn": "2017-08-19T08:39:54.714978+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>875b8bc9-1feb-4375-807a-e58a9f57e6a1</AssignedToUserId>
  <Cleared>true</Cleared>
  <DateAdded>2017-08-19T08:39:54.714978+00:00</DateAdded>
  <Distribution>All</Distribution>
  <Id>678c2d07-152a-4b53-bee5-0e9723625037</Id>
  <LastUpdated>2017-08-19T08:39:54.714978+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>2017-08-19T08:39:54.714978+00:00</PostedOn>
  <Private>true</Private>
  <RaisedById>4d7da2c8-d5bf-4979-9fa9-ef660ff63792</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>eefcbfdf-8c0b-4812-b21c-d0c7c2283b40</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>6151d9b9-afdd-465f-8af0-a7a70426542c</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>