Alarm Web API

The alarm service provides a RESTful web API that allows clients to retrieve and acknowledge alarm records.

Setup

The service is part of the Alarm Server in the Sym3 Operator Bundle. It is secured by OAuth authentication, which requires the installation and configuration of a certificate. The Sym3 Operator Bundle installer includes a step to bind the certificate to port 20021.

If for any reason the certificate is not bound to the port, the SSL and External page provides more details on how to obtain a self-signed certificate and retrieve the thumbprint of a certificate. The Alarm Web API listens on port 20021.

Accessing Sym3 Alarm Web API

Sym3 Alarm Web API base URL:

https://localhost:20021

If Sym3 Alarm Server is running on a remote machine, replace localhost with the domain name or IP address of the machine that is hosting Sym3 Alarm Server on your network.

Endpoints

Live alarm endpoint

[GET] base URL/v1/live/all

Query string parameters:

pageNumber - Page Number. Default value is 0 if missing.
pageSize - Page Size. Default value is 100 if missing.

History alarm endpoint

[GET] base URL/v1/history

Query string parameters:

from - Local time in 'yyyyMMddTHHmmss' format. Default value is the first second of current date if missing.
to - Local time in 'yyyyMMddTHHmmss' format.Default value is the current time if missing.
fromIndex - Starting record index. Default value is 0.
maxResults - Page Size. Default value is 100 if missing.
sortOrder - Options: 'OnTime', 'OffTime'. Case insensitive. 
isSortOrderDesc - Descendants and ascendants sortig flag. Default value is false.

Mixed alarm endpoint

[GET] base URL/v1/mixed

Query string parameters:

pageNumber - Page Number. Default value is 0 if missing.
pageSize - Page Size. Default value is 100 if missing.

Alarm acknowledge endpoint

[POST] base URL/v1/acknowledge

Request body:

{
    "alarmAck":{
        "workstation":"WORKSTATION1",
        "ackUser":"joe"
    },
    "alarmIds":[1002, 1003, 1004]
}

• The ‘alarmIds’ field is a collection of alarm record IDs that the user wants to acknowledge

Alarm acknowledge all endpoint

[POST] base URL/v1/acknowledge/all

Request body:

{
    "workstation":"WORKSTATION1",
    "ackUser":"joe"
}