Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

REST API Method: GET /rest/activealarm

Page Tree
rootResource - activealarm

Retrieves all resource schema elements and values of an active alarm in the system based on a requested Table ID.

Tip

If no Table ID is specified in the GET, a listing of all active alarms will be returned along with their associated IDs. These identifiers can be used to collect resource schema element values via the GET activealarm id method.

URL:

https://134.56.227.163/rest/activealarm

HTTP Method

GET

Requires Authentication:

true

Parameters

Name Required Values Description
filterNoruntimeThe type of filtered information in the response. If no filters are specified, all get applied.

Usage Example: (about cURL | requires a session token)

Code Block
languagebash
curl --cookie PHPSESSID=ima0r3nkaeg8mo0suln67vg4m7 --cacert 134.56.227.163.crt 
-i https://134.56.227.163/rest/activealarm

Response:

Code Block
languagehtml/xml
<?xml version="1.0"?> 
<root>
   <status>
     <http_code>200</http_code>
   </status>
   <activealarm_list count="3">
       <activealarm_pk id="1" href="https://134.56.227.163/rest/activealarm/1"/>
       <activealarm_pk id="2" href="https://134.56.227.163/rest/activealarm/2"/>
       <activealarm_pk id="3" href="https://134.56.227.163/rest/activealarm/3"/>
   </activealarm_list>
</root>