aYOUne
← Konfiguration API

Sensors

Singular: Sensor — Base-URL: https://config-api.ayoune.app — Zugriff: CRUD

play_circle Jetzt ausprobieren beta

Requests werden über den consumer-app Proxy an *.ayoune.app weitergeleitet. Tokens bleiben im Browser und werden pro Call mitgesendet.

Beispiel-Response (aufgezeichnet) Beispiel

Eine echte, zuvor aufgezeichnete GET /:id-Antwort dieses Endpunkts — nicht der Live-Call oben. Sensible Felder sind maskiert.

{
  "payload": {
    "_id": "65e0b066121b7d48fe157ed1",
    "multipleValues": false,
    "currentValue": 0,
    "maxValue": 0,
    "minValue": 0,
    "avgValue": 0,
    "avgValue5min": 0,
    "avgValue10min": 0,
    "avgValue60min": 0,
    "warnValue": 0,
    "alertValue": 0,
    "machineTransport": false,
    "domain": "default",
    "createdBy": "6045f4d25704710012485569",
    "actions": [],
    "channels": [],
    "createdAt": "2024-02-29T16:27:18.228Z",
    "updatedAt": "2024-02-29T16:27:18.228Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://config-api.ayoune.app/sensors/65e0b066121b7d48fe157ed1",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [
      {
        "rel": "WorkCenters",
        "title": "MODEL_WORKCENTER",
        "href": "https://api.ayoune.app/production/workcenters",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "production.workcenters"
      },
      {
        "rel": "Machines",
        "title": "MODEL_MACHINE",
        "href": "https://api.ayoune.app/config/machines",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.machines"
      },
      {
        "rel": "IoTDevices",
        "title": "MODEL_IOTDEVICE",
        "href": "https://api.ayoune.app/config/iotdevices",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.iotdevices"
      },
      {
        "rel": "States",
        "title": "MODEL_STATE",
        "href": "https://api.ayoune.app/config/states",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.states"
      }
    ],
    "debugId": "6a62de98f27d6098834b0981",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_SENSOR",
        "href": "https://api.ayoune.app/config/sensors/65e0b066121b7d48fe157ed1/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_SENSOR",
        "href": "https://api.ayoune.app/config/sensors/65e0b066121b7d48fe157ed1/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.95.0",
      "core": "2026.258.0"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "592",
      "reset": "1784865648",
      "resetDate": "Fri Jul 24 2026"
    },
    "responseTime": 108.732693,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpunkte

MethodePathBeschreibungRight
GET /sensors Liste mit Filtern/Paginierung config.sensors.view
GET /sensors/:id Einzelner Datensatz config.sensors.view
POST /sensors Neuen Datensatz erstellen config.sensors.new
PUT /sensors Datensatz aktualisieren config.sensors.edit
DELETE /sensors/:id Datensatz löschen config.sensors.delete

SDK

import { aYOUne } from '@tolinax/ayoune';
const ay = new aYOUne('pat_your_token');

// Alle abrufen
const list = await ay.config.sensors.find().limit(10).exec();

// Einzelnen Datensatz
const one = await ay.config.sensors.findById('OBJECT_ID').exec();

// Erstellen
const created = await ay.config.sensors.create({ name: 'Foo' });

Weiterführend