Skip to main content
GET
/
sensors
/
{uuid}
Get sensor
curl --request GET \
  --url http://localhost:8000/sensors/{uuid} \
  --header 'X-API-KEY: <api-key>'
{
  "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "model": "HPT604-V",
  "type": "ph",
  "physicalSensor": {
    "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "serialNumber": "<string>"
  },
  "connectionType": "integrated",
  "name": "<string>",
  "alias": "<string>",
  "deviceSerialNumber": "<string>",
  "parameters": [
    {
      "deviceSerialNumber": "<string>",
      "sensorUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "alias": "<string>",
      "name": "<string>",
      "parameterType": "temperature",
      "baseUnit": "<string>",
      "displayUnit": "<string>",
      "displayPrecision": 123,
      "suppressFaults": true,
      "sourceType": "<string>",
      "readIndex": 123,
      "deviceAlarmSupported": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "parameterPath": {
        "deviceSerialNumber": "1234567890",
        "sensorName": "VibratingWire_CH1",
        "parameterName": "Frequency_CH1"
      },
      "status": "ok",
      "configErrorMessage": "<string>",
      "lastFaultSummary": {
        "reason": "null_value",
        "message": "<string>",
        "faultyPointsCount": 123,
        "totalPointsCount": 123
      },
      "lastFaultTimestamp": "2023-11-07T05:31:56Z"
    }
  ],
  "channelIndex": 123,
  "isActive": true,
  "health": {
    "status": "ok",
    "warnings": [
      "<string>"
    ],
    "errors": [
      "<string>"
    ]
  },
  "attributes": [
    {
      "behaviour": "static",
      "name": "<string>",
      "alias": "<string>",
      "valueType": "numeric",
      "value": 123,
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "attributeSource": "custom",
      "description": "<string>",
      "unit": "<string>",
      "function": "offset",
      "parameterType": "unknown",
      "timestamp": "2023-11-07T05:31:56Z",
      "sensorUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "physicalSensorUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "optionSet": {
        "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "description": "<string>",
        "orgUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "optionsType": "numeric",
        "options": [
          {
            "value": 123,
            "label": "<string>"
          }
        ],
        "allowCustomValue": true
      },
      "template": {
        "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "templateName": "<string>"
      },
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "lastActivatedAt": "2023-11-07T05:31:56Z",
  "lastDeactivatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
X-API-KEY
string
header
required

API key for authentication passed in the X-API-KEY header.

Example: X-API-KEY: <apiKey>

Path Parameters

​
uuid
string<uuid>
required

Sensor UUID

Response

Successful response

​
uuid
string<uuid>
required

Sensor UUID

​
model
enum<string>
required

Sensor model identifier

Available options:
HPT604-V,
HPT604-ABS,
ATMOS41,
SPS30,
ATMOS22,
ONTOTO-RADAR,
UE3002,
VW-GENERIC,
WDS308,
VIBWIRE-108-SDI12,
PULSE-RAIN,
PULSE-WATER-METER,
SEN50,
ANB-AQ5,
EP100G,
EP100GL,
SENTEK,
4-20MA,
UNICONN,
CBS-BUBBLER,
HPT915,
SMART-IPI,
SO411,
TDR310,
SMR02,
SMR07,
SMR04,
SMR05,
SMR09,
BAROMETER,
HWT9053,
PONSEL-PH,
PONSEL-C4E,
PONSEL-NTU,
GEOKON-6180,
UF2000B,
AS3935,
VM5XX,
WXT536,
PT12,
TILT,
SMRMAX,
AQUA-TROLL-100,
DAX-CTD,
G6,
SMR-LEVEL-EC,
SOLINST-ABS,
HPT604-VT,
SMART-CONTRACT,
VW-SDI12
​
type
enum<string>
required

Sensor type

Available options:
absolute_pressure,
gauge_pressure,
absolute_pressure_conductivity,
barometer,
weather,
vibrating_wire,
pulse_rain,
pulse_water_meter,
dust,
radar,
ph,
soil_moisture,
gauge_pressure_temp,
oxygen_gas,
ultrasonic_flow,
ma420,
wind,
ultrasonic_distance,
bubbler_level,
inclinometer,
conductivity,
turbidity,
lightning,
orp,
dissolved_oxygen,
conductivity_ph,
linear_displacement
Example:

"ph"

​
physicalSensor
object
required

Assigned physical sensor, if any

​
connectionType
enum<string>
required

Sensor connection type

Available options:
integrated,
external
​
name
string
required

Internal name used for the sensor

​
alias
string
required

Sensor alias for display purposes

​
deviceSerialNumber
string
required

Serial number of the device that owns the sensor

​
parameters
object[]
required

Array of sensor parameters

​
channelIndex
number
required

Order the sensor is read on the device

​
isActive
boolean
required

Whether the sensor is currently active on the device

​
health
object
required

Health of the sensor

​
attributes
object[] | null

Assigned sensor attributes

​
lastActivatedAt
string<date-time> | null

Timestamp of when the sensor was last activated

​
lastDeactivatedAt
string<date-time> | null

Timestamp of when the sensor was last deactivated