How can we help?


0 results found

AlarmInstances/Get (List)

GET /odata/AlarmInstances


Retrieves a list of all the AlarmInstances.

To get the details of a specific AlarmInstance, refer to AlarmInstances/Get (Specific).

See the following for request and response details:

See also:

Request ‒ AlarmInstances/Get (List)

Property Type Description Mandatory
Id String A unique identifier for this AlarmInstance that is automatically generated by Axonize. This AlarmInstance ID is returned in the response of the AlarmInstances/Post. Y

Example JSON AlarmInstances/Get (List) Request

curl -X GET \

-H ‘Authorization: Token’ \

  -H ‘Content-Type: application/json’ \

  -H ‘appId: 801A048A-9F23-429F-BF0D-B6D35B22723E’

Response ‒ AlarmInstances/Get (List)

For each AlarmInstance, the response provides the properties in AlarmInstances/Post.

Example JSON AlarmInstances/Get (List) Response

Status 200 – OK


    “@odata.context”: “$metadata#AlarmInstances“,

    “value”: [


            “deviceId”: “5a8c35d119ec0c14b8512345”,

            “typeCode”: 1039,

            “value”: “50”,

            “readingDateTime”: “2018-07-02T07:57:29Z”,

            “readingDateTimeOffset”: “2018-07-02T07:57:29Z”,

            “ruleId”: “5b28a5a421b5bb1dc8a21c9b”,

            “eventName”: “Soil Humidity”,

            “severity”: “Warning”,

            “status”: “Open”,

            “snoozeExpirationDate”: null,

            “message”: “Warning alarm from Doneness – Soil Humidity = 50 on value 50”,

            “id”: “5b39daed19ec0c12ac212345”,

            “appId”: “801A048A-9F23-429F-BF0D-B6D35B212345”,

            “createDate”: “2018-07-02T07:57:33.692Z”,

            “createUser”: null,

            “updateDate”: “0001-01-01T00:00:00Z”,

            “updateUser”: null