Skip to main content
GET
/
devices
/
{sn}
Get device
curl --request GET \
  --url https://api.beta.ontoto.com/v1/devices/{sn} \
  --header 'x-api-key: <api-key>'
{
  "deviceKind": "physical",
  "serialNumber": "2CF44434E908",
  "alias": "North mine piezometer",
  "description": "Vibrating wire settlement gauge",
  "name": "NW-PZ-01",
  "orgUuid": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "legacyDeviceId": 10042,
  "site": {
    "uuid": "31d09506-82da-4f9d-960f-a871bae63258",
    "name": "River Dam"
  },
  "location": {
    "lat": -42.8814,
    "lon": 147.3258
  },
  "samplingPeriodSeconds": 600,
  "txPeriodSeconds": 3600,
  "state": "active",
  "health": {
    "battery": {
      "voltage": 3.72,
      "percentage": 87,
      "remaining": "56d remaining",
      "isCharging": false
    },
    "connection": {
      "lastSeen": "2024-06-15T08:42:11.000Z",
      "status": "online",
      "signalStrength": {
        "rssi": -71,
        "rsrp": -95,
        "rsrq": -12,
        "signalQuality": "good"
      },
      "error": null,
      "txProtocol": "coap",
      "nextTxTimestamp": "2024-06-15T09:42:11.000Z"
    },
    "sensors": {
      "status": "ok",
      "metadataError": null,
      "errors": null,
      "lastDataTimestamp": "2024-06-15T08:41:03.000Z"
    },
    "powerSource": "battery"
  },
  "lastTxTimestamp": "2024-06-15T08:42:11.000Z",
  "product": "Greyhound",
  "hardware": {
    "model": "GH5",
    "revision": "1.2"
  },
  "modems": [
    {
      "type": "lte",
      "model": "EG800Q",
      "imei": "861234056789012",
      "iccid": "89014103211118510720"
    }
  ],
  "firmware": {
    "string": "GH5_REV1.2_VW_1_ff",
    "version": "2.4.1"
  },
  "tags": [
    {
      "id": 12,
      "name": "Dam monitoring",
      "colour": "#1E88E5"
    }
  ],
  "queuedCommand": null,
  "gnss": null,
  "sharedBy": null,
  "sensors": [
    {
      "uuid": "b2c3d4e5-f6a7-48b9-c0d1-e2f3a4b5c6d7",
      "model": "VW-GENERIC",
      "type": "vibrating_wire",
      "physicalSensor": null,
      "connectionType": "integrated",
      "name": "VibratingWire_CH1",
      "alias": "VW channel 1",
      "deviceSerialNumber": "2CF44434E908",
      "parameters": [
        {
          "uuid": "c3d4e5f6-a7b8-49c0-d1e2-f3a4b5c6d7e8",
          "sensorUuid": "b2c3d4e5-f6a7-48b9-c0d1-e2f3a4b5c6d7",
          "deviceSerialNumber": "2CF44434E908",
          "alias": "Frequency",
          "name": "frequency_1",
          "sourceType": "raw",
          "parameterType": "frequency",
          "baseUnit": "Hz",
          "displayUnit": "Hz",
          "displayPrecision": 2,
          "suppressFaults": false,
          "configErrorMessage": null,
          "status": "ok",
          "lastFaultSummary": null,
          "lastFaultTimestamp": null,
          "createdAt": "2024-01-10T00:00:00.000Z",
          "updatedAt": "2024-06-01T12:00:00.000Z"
        }
      ],
      "channelIndex": 0,
      "isActive": true,
      "lastActivatedAt": "2024-01-01T00:00:00.000Z",
      "lastDeactivatedAt": null,
      "enabled": true
    }
  ]
}

Authorizations

x-api-key
string
header
required

Path Parameters

sn
string
required

Response

Successful response

Device record

deviceKind
required

Physical hardware device

Allowed value: "physical"
serialNumber
string
required
alias
string | null
required

Server-set alias, primary display for UI purposes

description
string | null
required

Optional description

name
string | null
required

Name synchronised with device. Displayed as fallback if alias is not set

orgUuid
string<uuid>
required

Organisation the device belongs to

legacyDeviceId
integer | null
required

Legacy device id for backwards compatibility

Required range: -9007199254740991 <= x <= 9007199254740991
location
object | null
required

Device location in WGS84 coordinates

samplingPeriodSeconds
number | null
required

Current sampling period in seconds

txPeriodSeconds
number | null
required

Current transmission period in seconds

state
required

Device is undergoing internal hardware testing and validation

Allowed value: "testing"
health
object
required

Health of the device

lastTxTimestamp
string<date-time> | null
required

Last received transmission timestamp

product
string | null
required

Product name for physical devices

hardware
object | null
required

Hardware details for physical devices

modems
object[]
required

Modems attached to the device. Some device models may support two modems (LTE + satellite)

firmware
object | null
required

Firmware information

tags
object[]
required

Tags associated with the device

site
object | null

Site the device is assigned to, if any

sensors
SensorItem · object[]

Sensors attached to the device

queuedCommand
object | null

If a command is currently queued or processing for this device, a summary of the command

gnss
object | null

For devices with GNSS support, the GNSS processing configuration

sharedBy
SharedBy · object | null

Present when this device is shared from another organisation