GET alarm/definitions

Gets a list of all of the alarm definition for all alarms from all available sites.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

ResponseVMOfAlarmDefinitionVM

Name	Type	Additional information
Resources	Collection of AlarmDefinitionVM	None.
ResultCode	FwApiResultCode	None.
ResultMessage	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Resources": [
    {
      "id": 1,
      "type": "sample string 2",
      "enabled": true,
      "name": "sample string 4",
      "rule": "sample string 5",
      "site": {
        "id": 1,
        "name": "sample string 2"
      },
      "actions": [
        {
          "type": "sample string 1",
          "detail": "sample string 2"
        },
        {
          "type": "sample string 1",
          "detail": "sample string 2"
        }
      ],
      "ackreqd": true,
      "dwelltime": 1,
      "repeatinterval": 1,
      "ackrepeatinterval": 1,
      "expires": "2025-05-29T14:46:45.6433452-07:00",
      "validdays": "sample string 7"
    },
    {
      "id": 1,
      "type": "sample string 2",
      "enabled": true,
      "name": "sample string 4",
      "rule": "sample string 5",
      "site": {
        "id": 1,
        "name": "sample string 2"
      },
      "actions": [
        {
          "type": "sample string 1",
          "detail": "sample string 2"
        },
        {
          "type": "sample string 1",
          "detail": "sample string 2"
        }
      ],
      "ackreqd": true,
      "dwelltime": 1,
      "repeatinterval": 1,
      "ackrepeatinterval": 1,
      "expires": "2025-05-29T14:46:45.6433452-07:00",
      "validdays": "sample string 7"
    }
  ],
  "ResultCode": 0,
  "ResultMessage": "sample string 1"
}

application/xml, text/xml

Sample:

<ResponseVMOfAlarmDefinitionVMFXJgzlgx xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FW.WebApi2.ViewModels">
  <ResultCode>Ok</ResultCode>
  <ResultMessage>sample string 1</ResultMessage>
  <Resources>
    <AlarmDefinitionVM>
      <ackrepeatinterval>1</ackrepeatinterval>
      <ackreqd>true</ackreqd>
      <actions>
        <ActionVM>
          <detail>sample string 2</detail>
          <type>sample string 1</type>
        </ActionVM>
        <ActionVM>
          <detail>sample string 2</detail>
          <type>sample string 1</type>
        </ActionVM>
      </actions>
      <dwelltime>1</dwelltime>
      <enabled>true</enabled>
      <expires>2025-05-29T14:46:45.6433452-07:00</expires>
      <id>1</id>
      <name>sample string 4</name>
      <repeatinterval>1</repeatinterval>
      <rule>sample string 5</rule>
      <site>
        <id>1</id>
        <name>sample string 2</name>
      </site>
      <type>sample string 2</type>
      <validdays>sample string 7</validdays>
    </AlarmDefinitionVM>
    <AlarmDefinitionVM>
      <ackrepeatinterval>1</ackrepeatinterval>
      <ackreqd>true</ackreqd>
      <actions>
        <ActionVM>
          <detail>sample string 2</detail>
          <type>sample string 1</type>
        </ActionVM>
        <ActionVM>
          <detail>sample string 2</detail>
          <type>sample string 1</type>
        </ActionVM>
      </actions>
      <dwelltime>1</dwelltime>
      <enabled>true</enabled>
      <expires>2025-05-29T14:46:45.6433452-07:00</expires>
      <id>1</id>
      <name>sample string 4</name>
      <repeatinterval>1</repeatinterval>
      <rule>sample string 5</rule>
      <site>
        <id>1</id>
        <name>sample string 2</name>
      </site>
      <type>sample string 2</type>
      <validdays>sample string 7</validdays>
    </AlarmDefinitionVM>
  </Resources>
</ResponseVMOfAlarmDefinitionVMFXJgzlgx>