Schema inference

Each device has its own Data Schema, describing which type of data is available on which topic. This schema can be inferred from the stored data and queried over the REST API. The inferred schema is combined from both device type schema and effective data that is measured by the device. The device type schema can be used to further annotate the underlying data model and units.

Infer schema

GET https://api.akenza.io/v3/devices/{deviceId}/infer-schema

Infer the schema of a device identified by its id

The /infer-schema/ endpoint returns a maximum of 50 topics.

Query Parameters

Name	Type	Description
deviceId	String	akenza device id of the sensor

Response example

{
    "lifecycle": { // topic
        "$id": "https://akenza.io/dynamic/08fe4bc0d0994882/lifecycle.schema.json",
        "$schema": "http://json-schema.org/draft-07/schema#",
        "title": "Lifecycle",
        "type": "object",
        "properties": {
            "batteryVoltage": { // data key
                "title": "Battery Voltage",
                "type": "number",
                "inferred": true,
                "properties": {}
            },
            "batteryLevel": {
                "title": "Battery Level",
                "type": "number",
                "inferred": true,
                "properties": {}
            }
        }
    },
    "default": {
        "$id": "https://akenza.io/internal/deviceSimulator/default.schema.json",
        "$schema": "http://json-schema.org/draft-07/schema#",
        "title": "Default",
        "type": "object",
        "properties": {
            "illuminance": {
                "title": "Light",
                "unit": "lx",
                "$ref": "https://raw.githubusercontent.com/akenza-io/device-type-library/main/data-models/environment/schema.json#/$defs/illuminance/lux",
                "measurementType": "akenza/environment/illuminance/lux",
                "type": "number",
                "description": "Light value",
                "properties": {}
            },
            "light": {
                "title": "Light",
                "type": "number",
                "inferred": true,
                "properties": {}
            },
            "co2": {
                "title": "CO2",
                "unit": "ppm",
                "$ref": "https://raw.githubusercontent.com/akenza-io/device-type-library/main/data-models/environment/schema.json#/$defs/co2/ppm",
                "measurementType": "akenza/environment/co2/ppm",
                "type": "number",
                "description": "Carbon Dioxide in ppm",
                "properties": {}
            },
            "sound": {
                "title": "Sound",
                "unit": "dB(A)",
                "$ref": "https://raw.githubusercontent.com/akenza-io/device-type-library/main/data-models/environment/schema.json#/$defs/soundLevel/dba",
                "measurementType": "akenza/environment/soundLevel/dba",
                "type": "number",
                "description": "Average value of the sound pressure level in decibel",
                "minimum": 20,
                "maximum": 120,
                "properties": {}
            },
            "temperature": {
                "title": "Temperature",
                "unit": "°C",
                "$ref": "https://raw.githubusercontent.com/akenza-io/device-type-library/main/data-models/environment/schema.json#/$defs/temperature/celsius",
                "measurementType": "akenza/environment/temperature/celsius",
                "type": "number",
                "description": "Temperature in degrees Celcius",
                "properties": {}
            },
            "humidity": {
                "title": "Humidity",
                "unit": "%",
                "$ref": "https://raw.githubusercontent.com/akenza-io/device-type-library/main/data-models/environment/schema.json#/$defs/humidity/percent",
                "measurementType": "akenza/environment/humidity/percent",
                "type": "number",
                "description": "Relative humidity in percent",
                "minimum": 0,
                "maximum": 100,
                "properties": {}
            },
            "occupied": {
                "title": "Occupied",
                "$ref": "https://raw.githubusercontent.com/akenza-io/device-type-library/main/data-models/spaces/schema.json#/$defs/occupied/boolean",
                "measurementType": "akenza/spaces/occupied/boolean",
                "type": "boolean",
                "description": "Whether the space is occupied",
                "properties": {}
            }
        }
    }
}