Conduit Alert

Conduit Alert provides a full set of alert/alarm information. Best used to register alarms and update alarms in other systems.

SECURITY NOTE: Conduit Alert uses GET method so request data forms part of the URL. This means your security token could potentially be Stored in browser history or in web server logs.

HTTP Method

GET Request

Default URL:

https://api.alphax.cloud/conduitAlert?token=xxxxxxxxxxxxxxxxxxxx

Important Note: When utilizing the default URL above, the API will fetch All alerts assigned to the entity associated with the token.

Parameters

Parameter	Description	Input	Required
token	The unique security token for each user. This is available from the User window in AlphaX.	String	Required
id	The alert ID If not defined, you will get all alerts assigned to the entity associated with the token.	String	Optional
siteid	The id of Entity(Heirarchy). You will get information of all alerts that assigned to the site and its sub sites. If not defined, you will get all alerts assigned to the entity associated with the token.	String	Optiona

Parameter

Description

Input

Required

token

The unique security token for each user. This is available from the User window in AlphaX.

String

Required

The alert ID

If not defined, you will get all alerts assigned to the entity associated with the token.

String

Optional

siteid

The id of Entity(Heirarchy). You will get information of all alerts that assigned to the site and its sub sites.

If not defined, you will get all alerts assigned to the entity associated with the token.

String

Optiona

Output

[
    ...,
    {
        "type": "alert",
        "name": "Min Alert Test 001",
        "alertId": "66a874ab9c14170adf0421b2",
        "siteid": "6644803e41b6e774bc01a1c2",
        "siteName": "TEST",
        "conditionalStatus": {
            "status": "auto",
            "timeRange": "16-19",
            "weekdays": {
                "monday": true,
                "tuesday": true,
                "wednesday": true,
                "thursday": true,
                "friday": true,
                "saturday": false,
                "sunday": false
            },
            "months": {
                "jan": true,
                "feb": false,
                "mar": false,
                "apr": false,
                "may": false,
                "jun": false,
                "jul": false,
                "aug": false,
                "sep": false,
                "oct": false,
                "nov": false,
                "dec": false
            }
        },
        "alertStatus": "inactive",
        "conditions": [
            {
                "label": "<10",
                "limit": 10,
                "condition": "below"
            },
            {
                "label": "Offline",
                "limit": null,
                "condition": "offline"
            }
        ],
        "sensors": [
            {
                "netid": "66a874ac9c14170adf0421b4",
                "chid": "1",
                "lastTriggered": 1722317100,
                "status": false,
                "alertedConds": []
            },
            {
                "netid": "Mozart-Test-001",
                "chid": "1",
                "lastTriggered": 1722317461,
                "status": false,
                "alertedConds": []
            },
            {
                "netid": "Mozart-Test-001",
                "chid": "2",
                "lastTriggered": 1722830028,
                "status": true,
                "alertedConds": [
                    {
                        "label": "<10",
                        "limit": 10,
                        "condition": "below"
                    }
                ]
            },
            {
                "netid": "Mozart-Test-001",
                "chid": "3",
                "lastTriggered": 1722317163,
                "status": false,
                "alertedConds": []
            }
        ]
    },
    ...
]

Definition:

Historical: Each record saved in database individually. Can not be manually changed in AlphaX platform.
Live: The data from current record. All of them were from one same record in database. Can be changed by editing fields in AlphaX platform.

Output Key	Description	Data Type
`type`	Type of the record	Historical
`name`	Name of this Alert	Live
`alertId`	ID of this Alert	Historical
`siteid`	Site ID of this Alert	Live
`siteName`	Site Name of this Alert	Live
`conditionalStatus`	Active Condition of this Alert. See Detail below.	Live
`alertStatus`	Active Condition of this Alert. See Detail below.	Live
`conditions`	Alarm Conditions of this Alert. See Detail below.	Live
`sensors`	Sensors associated with this Alert. See Detail below.	Live

Output Key: conditionalStatus & alertStatus

If conditionalStatus.status is auto, the alert will be actived/enabled during conditionalStatus.weekdays, conditionalStatus.monthsand conditionalStatus.timeRange. In the example above, the alert is actived/enabled in January weekdays from 16:00 to 19:00.
If conditionalStatus.status is manual, the alert will be actived/enabled if the alertStatus is active.

Output Key: conditions

Output Key	Description	Data Type
`label`	Label of this Condition	Live
`limit`	Limit/value of this Condition	Live
`condition`	Condition	Live

Values of condition

Value	Alert will be Triggered when:
`below`	The sensor value below `limit`
`equal`	The sensor value equal `limit`
`above`	The sensor value above `limit`
`offline`	The sensor is offline
`online`	The sensor is online
`error`	The sensor receives error code

Output Key: sensors

Output Key	Description	Data Type
`netid`	Network ID of this Sensor	Live
`chid`	Channel ID of this Sensor	Live
`lastTriggered`	Date of this Sensor last triggered within this Alert in number. 10 Digits	Historical
`status`	Alarm status of this Sensor within this Alert If `status`= true: Sensor Alerted If `status`= false: Sensor NOT Alerted	Historical
`alertedConds`	Last triggered condition	Historical

Examples

Get Information of All Alerts

https://api.alphax.cloud/conduitAlert?token=xxxxxxxxxxxxxxxxxxxxxx

Returns information of all alerts assigned to the entity associated with the token.

Get Information of An Alert

https://api.alphax.cloud/conduitAlert?token=xxxxxxxxxxxxxxxxxxxxxx&id=66xxxc14xxxb2

Returns information of the Alert: 66xxxc14xxxb2