search

Query alarms

How to access the alarms within your company in evalink talos.

Receiving a list of the currently active alarms within your company in evalink talos is one of the most important API Requests you might need to use in your interactions with the service.

hashtag
get a list of alarms for your company

GET https:://talos-app.io/api/alarm-service/alarms/search/findByCompanyId:companyId

Use this endpoint to receive a list of active alarms in evalink talos for a specific company.

hashtag
Query Parameters

Name
Type
Description

companyId

string

The Company ID, as it is displayed on the evalink talos Web Interface.

hashtag
Headers

Name
Type
Description

Authorization

string

Use 'Bearer' followed by your API token.

{
  "_embedded": {
    "alarms": [
      {
        "alarmCode": "string",
        "alarmMsg": "string",
        "alarmStatus": "CLOSED",
        "alarmStoredTimestamp": 0,
        "alarmType": "string",
        "alarmValue": true,
        "alarmZone": "string",
        "alarmZoneName": "string",
        "channelId": "string",
        "companyId": "string",
        "definition": "string",
        "deviceGroupId": "string",
        "deviceId": "string",
        "headers": [
          {
            "name": "string",
            "value": "string"
          }
        ],
        "id": "string",
        "messageId": "string",
        "partition": "string",
        "partitionName": "string",
        "payload": "string",
        "protocol": "CONTACT_ID",
        "severity": 0,
        "shortId": "string",
        "source": "string",
        "technical": true,
        "testMessage": true,
        "timestamp": 0
      }
    ]
  },
  "_links": {}
}

hashtag
get a list of alarms for a particular site (device)

GET https://talos-app.io/api/alarm-service/alarms/search/findByDeviceId:deviceId

Use this endpoint to receive a list of active alarms in evalink talos for a specific site (device) and company.

hashtag
Query Parameters

Name
Type
Description

deviceId

string

The Device ID, as it is displayed in your evalink talos Web Interface.

hashtag
Headers

Name
Type
Description

Authorization

string

Use 'Bearer' followed by your API token.

PreviousSend alarms using RESTNextManage users

Last updated

Was this helpful?