GET v2/DataPointAlerts?SortBy={SortBy}&SortOrder={SortOrder}

Retrieve the list of data point alerts that are defined.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
SortBy

Gets or sets the name of the field to sort by.

string

None.

SortOrder

Gets or sets the sort order.

Lhp.EquipmentIntelligence.WebApi.Models.SortOrders

None.

Body Parameters

None.

Response Information

Resource Description

Collection of Lhp.EquipmentIntelligence.WebApi.Client.Models.DataPointAlert
NameDescriptionTypeAdditional information
DataPointAlertId

Unique identifier for this data point alert.

integer

None.

Name

Friendly name for the alert.

string

None.

Description

Detailed description of the data point alert.

string

None.

ShortDescription

Brief description of the data point alert.

string

None.

AlertFrequency

Frequency that the alert sends a notification once triggered.

Lhp.EquipmentIntelligence.AlertFrequencies

None.

AlertFrequencyInterval

Interval at which an alert sends a notification when triggered.

integer

None.

AssetTargetType

Indicates the range of assets that can cause this alert to trigger.

Lhp.EquipmentIntelligence.AssetTargetTypes

None.

AssetTargetId

Refers to the asset target whose type is determined by AssetTargetType.

integer

None.

Tags

An optional list of tags that may be used to further categorize or qualify the data point alert definition.

Collection of string

None.

Conditions

Conditions that govern when the alert is triggered.

Collection of Lhp.EquipmentIntelligence.WebApi.Client.Models.DataPointAlertCondition

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "DataPointAlertId": 1,
    "Name": "sample string 2",
    "Description": "sample string 3",
    "ShortDescription": "sample string 4",
    "AlertFrequency": 0,
    "AlertFrequencyInterval": 1,
    "AssetTargetType": 0,
    "AssetTargetId": 1,
    "Tags": [
      "sample string 1",
      "sample string 2"
    ],
    "Conditions": [
      {
        "DataPointAlertConditionId": 1,
        "AlertConditionType": 0,
        "CompareOperator": 0,
        "CompareValue": 2.0,
        "Days": 1,
        "MeasurementUnit": 0,
        "DataPointId": 3
      },
      {
        "DataPointAlertConditionId": 1,
        "AlertConditionType": 0,
        "CompareOperator": 0,
        "CompareValue": 2.0,
        "Days": 1,
        "MeasurementUnit": 0,
        "DataPointId": 3
      }
    ]
  },
  {
    "DataPointAlertId": 1,
    "Name": "sample string 2",
    "Description": "sample string 3",
    "ShortDescription": "sample string 4",
    "AlertFrequency": 0,
    "AlertFrequencyInterval": 1,
    "AssetTargetType": 0,
    "AssetTargetId": 1,
    "Tags": [
      "sample string 1",
      "sample string 2"
    ],
    "Conditions": [
      {
        "DataPointAlertConditionId": 1,
        "AlertConditionType": 0,
        "CompareOperator": 0,
        "CompareValue": 2.0,
        "Days": 1,
        "MeasurementUnit": 0,
        "DataPointId": 3
      },
      {
        "DataPointAlertConditionId": 1,
        "AlertConditionType": 0,
        "CompareOperator": 0,
        "CompareValue": 2.0,
        "Days": 1,
        "MeasurementUnit": 0,
        "DataPointId": 3
      }
    ]
  }
]

application/xml, text/xml

Sample:
<ArrayOfDataPointAlert xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <DataPointAlert>
    <DataPointAlertId>1</DataPointAlertId>
    <Name>sample string 2</Name>
    <Description>sample string 3</Description>
    <ShortDescription>sample string 4</ShortDescription>
    <AlertFrequency>None</AlertFrequency>
    <AlertFrequencyInterval>1</AlertFrequencyInterval>
    <AssetTargetType>None</AssetTargetType>
    <AssetTargetId>1</AssetTargetId>
    <Tags>
      <string>sample string 1</string>
      <string>sample string 2</string>
    </Tags>
    <Conditions>
      <DataPointAlertCondition>
        <DataPointAlertConditionId>1</DataPointAlertConditionId>
        <AlertConditionType>None</AlertConditionType>
        <CompareOperator>LessThan</CompareOperator>
        <CompareValue>2</CompareValue>
        <Days>1</Days>
        <MeasurementUnit>None</MeasurementUnit>
        <DataPointId>3</DataPointId>
      </DataPointAlertCondition>
      <DataPointAlertCondition>
        <DataPointAlertConditionId>1</DataPointAlertConditionId>
        <AlertConditionType>None</AlertConditionType>
        <CompareOperator>LessThan</CompareOperator>
        <CompareValue>2</CompareValue>
        <Days>1</Days>
        <MeasurementUnit>None</MeasurementUnit>
        <DataPointId>3</DataPointId>
      </DataPointAlertCondition>
    </Conditions>
  </DataPointAlert>
  <DataPointAlert>
    <DataPointAlertId>1</DataPointAlertId>
    <Name>sample string 2</Name>
    <Description>sample string 3</Description>
    <ShortDescription>sample string 4</ShortDescription>
    <AlertFrequency>None</AlertFrequency>
    <AlertFrequencyInterval>1</AlertFrequencyInterval>
    <AssetTargetType>None</AssetTargetType>
    <AssetTargetId>1</AssetTargetId>
    <Tags>
      <string>sample string 1</string>
      <string>sample string 2</string>
    </Tags>
    <Conditions>
      <DataPointAlertCondition>
        <DataPointAlertConditionId>1</DataPointAlertConditionId>
        <AlertConditionType>None</AlertConditionType>
        <CompareOperator>LessThan</CompareOperator>
        <CompareValue>2</CompareValue>
        <Days>1</Days>
        <MeasurementUnit>None</MeasurementUnit>
        <DataPointId>3</DataPointId>
      </DataPointAlertCondition>
      <DataPointAlertCondition>
        <DataPointAlertConditionId>1</DataPointAlertConditionId>
        <AlertConditionType>None</AlertConditionType>
        <CompareOperator>LessThan</CompareOperator>
        <CompareValue>2</CompareValue>
        <Days>1</Days>
        <MeasurementUnit>None</MeasurementUnit>
        <DataPointId>3</DataPointId>
      </DataPointAlertCondition>
    </Conditions>
  </DataPointAlert>
</ArrayOfDataPointAlert>