Skip to main content
GET
/
sites
/
{uuid}
Get site
curl --request GET \
  --url https://api.beta.ontoto.com/sites/{uuid} \
  --header 'x-api-key: <api-key>'
{
  "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "orgUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "description": "<string>",
  "timezone": "<string>",
  "devices": [
    {
      "deviceKind": "physical",
      "serialNumber": "<string>",
      "alias": "<string>",
      "description": "<string>",
      "name": "<string>",
      "orgUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "legacyDeviceId": 0,
      "location": {
        "lat": 123,
        "lon": 123
      },
      "samplingPeriodSeconds": 123,
      "txPeriodSeconds": 123,
      "state": "testing",
      "health": {
        "battery": {
          "voltage": 3.72,
          "percentage": 87,
          "remaining": "10h 15m remaining",
          "isCharging": false
        },
        "connection": {
          "lastSeen": "2024-06-15T08:42:11.000Z",
          "status": "online",
          "signalStrength": {
            "rssi": -71,
            "rsrp": -95,
            "rsrq": -12,
            "signalQuality": "good"
          },
          "error": null,
          "txSuccessRate": null,
          "txProtocol": null,
          "nextTxTimestamp": "2024-06-15T09:42:11.000Z"
        },
        "sensors": {
          "status": "ok",
          "metadataError": null,
          "errors": [],
          "lastDataTimestamp": "2024-06-15T08:41:03.000Z"
        },
        "powerSource": "battery"
      },
      "lastTxTimestamp": "2023-11-07T05:31:56Z",
      "product": "<string>",
      "hardware": {
        "model": "<string>",
        "revision": "<string>"
      },
      "modems": [
        {
          "type": "astrocast",
          "model": "<string>",
          "imei": "<string>",
          "iccid": "<string>",
          "uuid": "<string>"
        }
      ],
      "firmware": {
        "string": "<string>",
        "version": "<string>"
      },
      "tags": [
        {
          "id": 123,
          "name": "<string>",
          "colour": "<string>"
        }
      ],
      "_internal": {
        "peripheralId": 123,
        "metadata": null,
        "config": null,
        "boardId": 123
      },
      "site": {
        "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      },
      "sensors": [
        {
          "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "model": "HPT604-V",
          "type": "ph",
          "physicalSensor": {
            "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "serialNumber": "<string>"
          },
          "connectionType": "external",
          "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,
          "enabled": true,
          "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"
        }
      ],
      "queuedCommand": {
        "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "status": "processing",
        "createdAt": "2023-11-07T05:31:56Z"
      },
      "gnss": {
        "enableLeverArmCompensation": true,
        "isBaseStation": true,
        "processingMode": "static",
        "antennaType": "<string>",
        "arpHeight": 123,
        "azimuth": 123,
        "baseStation": {
          "id": 123,
          "type": "cors",
          "name": "<string>",
          "status": "active",
          "isEnabled": true
        },
        "lastProcessingStatus": {
          "status": "success",
          "error": "<string>"
        },
        "lastProcessedAt": "2023-11-07T05:31:56Z"
      },
      "sharedBy": {
        "orgUuid": "<string>",
        "orgName": "<string>",
        "permissionLevel": "read"
      }
    }
  ],
  "gnss": {
    "verticalDatum": "<string>",
    "geoidModel": "ausgeoid2020",
    "baseStations": [
      {
        "baseStation": {
          "id": 123,
          "type": "cors",
          "name": "<string>",
          "status": "active",
          "isEnabled": true
        },
        "priority": 123,
        "isEnabled": true
      }
    ],
    "projections": [
      {
        "id": 123,
        "label": "<string>",
        "verticalDatum": "<string>",
        "heightType": "ellipsoidal",
        "projectionType": "<string>",
        "srid": 123
      }
    ]
  },
  "sharedBy": {
    "orgUuid": "<string>",
    "orgName": "<string>",
    "permissionLevel": "read"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.beta.ontoto.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

x-api-key
string
header
required

Path Parameters

uuid
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$

Response

Successful response

A site represents a physical location for devices

uuid
string<uuid>
required

Unique identifier

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$
orgUuid
string<uuid>
required

Organisation the site belongs to

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$
name
string
required

Site name

description
string | null
required

Optional description

timezone
string | null
required

IANA timezone override for devices at this site (e.g., 'Australia/Sydney')

devices
object[] | null

Devices assigned to this site, if requested

gnss
object

GNSS configuration, base stations, and projections for this site. Null when not configured.

sharedBy
object

Present when this site is shared from another organisation