DUET PlatformDocs
API referenceRead APIAlarms

List alarm occurrences

available
GET
/platform/v1/alarms

Lists the alarm occurrences in a project, each with its newest lifecycle events. Rows are sorted by synced_at, oldest first. You can filter by status, severity, and site. To read incrementally, use the updated_since and after watermark. All IDs are DUET IDs.

Authorization

Bearer
headerAuthorizationBearer <token>

Query Parameters

project_id*string

The ID of the project to read alarms from.

status?string

Returns only occurrences with this status: open, claimed, shelved, or resolved.

severity?string

Returns only occurrences with this severity: critical, high, medium, low, or info.

site?string

Returns only occurrences from this site.

updated_since?string

The replay watermark. Returns occurrences that DUET stored at or after this time, compared against synced_at. Rows are sorted by synced_at, oldest first. To resume, set updated_since to the last row's synced_at and after to its duet_occurrence_ref.

Formatdate-time
after?string

The duet_occurrence_ref of the last row you received. Skips the rows with the same synced_at that you already have. Requires updated_since.

limit?integer

The maximum number of rows to return. The default is 10,000 and the maximum is 10,000. A page with fewer than limit rows is the last page.

Range1 <= value <= 10000
Default10000
offset?|

The number of rows to skip. For replay, use the updated_since and after watermark instead. An offset can skip or repeat rows when rows change between pages.

Range0 <= value
Default0

Response Body

The alarm occurrences, oldest synced_at first.

application/json
  1. response
[index: integer]?
Example Request
curl -X GET 'https://api.enurgen.com/platform/v1/alarms?project_id=string'
Example Response
[  {    "occurrence_id": "string",    "duet_occurrence_ref": "string",    "source": "string",    "organization_id": "string",    "project_id": "string",    "site": "string",    "rule_name": "string",    "rule_version": 0,    "kind": "string",    "severity": "string",    "status": "string",    "resolution_policy": "string",    "resolution": "string",    "raised_at": "2019-08-24T14:15:22Z",    "source_ts": "2019-08-24T14:15:22Z",    "updated_at": "2019-08-24T14:15:22Z",    "synced_at": "2019-08-24T14:15:22Z",    "cleared_at": "2019-08-24T14:15:22Z",    "raised_value": 0,    "last_value": 0,    "peak_value": 0,    "peak_at": "2019-08-24T14:15:22Z",    "recovered_value": 0,    "source_tag": "string",    "measure": "string",    "rule_description": "string",    "decoded_labels": [      "string"    ],    "point_key": "string",    "alarm_class": "string",    "is_nerc": true,    "device_id": "string",    "device_name": "string",    "device_type": "string",    "parent_device_id": "string",    "params": null,    "events": [      {        "event_id": "string",        "occurrence_id": "string",        "duet_occurrence_ref": "string",        "type": "raised",        "kind": "string",        "created_at": "2019-08-24T14:15:22Z",        "synced_at": "2019-08-24T14:15:22Z",        "body": "string",        "user_id": "string",        "user_email": "string",        "external_user_id": "string",        "detail": null      }    ],    "events_total": 0,    "events_truncated": true  }]

List alarm events GET

Lists the alarm lifecycle events in a project as a flat feed. Rows are sorted by `synced_at`, oldest first. You can filter by site. To read incrementally, use the `updated_since`, `after`, and `after_event_id` watermark. All IDs are DUET IDs.

List sensors GET

Lists the sensors in a project's site hierarchy, with the DUET device that each one maps to. Every sensor in the hierarchy is returned, including sensors whose device isn't in DUET yet. With `lane=raw_signal`, lists every tag the site forwards instead, as returned in the `raw_signal` lane of `/platform/v1/signals`.