Zum Inhalt springen
aYOUne
← Konfiguration API

IoTDevices

Singular: IoTDevice — Base-URL: https://config-api.ayoune.app — Zugriff: CRUD — Maschinenlesbare Beschreibung (JSON · YAML)

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": {
    "stats": {
      "netstat": [],
      "inOut": []
    },
    "maintenanceForecast": {
      "reasons": []
    },
    "_id": "6aa76eac8e4d941dde87f0fc",
    "active": true,
    "capabilities": [],
    "status": "offline",
    "factoryNotes": "GLAD_TAN_C-3PO",
    "factoryTestResults": [],
    "createdBy": "6045f4d25704710012485569",
    "last_active": "2026-09-14T03:49:00.333Z",
    "values": [],
    "shares": [],
    "createdAt": "2026-09-14T03:49:00.334Z",
    "updatedAt": "2026-09-14T03:54:21.878Z",
    "offlineSince": "2026-09-14T03:54:21.878Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://config-api.ayoune.app/iotdevices/6aa76eac8e4d941dde87f0fc",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [
      {
        "rel": "CompanyLocations",
        "title": "MODEL_COMPANYLOCATION",
        "href": "https://api.ayoune.app/config/companylocations",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.companylocations"
      },
      {
        "rel": "StorageAreas",
        "title": "MODEL_STORAGEAREA",
        "href": "https://api.ayoune.app/config/storageareas",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.storageareas"
      },
      {
        "rel": "BuildingSpaces",
        "title": "MODEL_BUILDINGSPACE",
        "href": "https://api.ayoune.app/config/buildingspaces",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.buildingspaces"
      },
      {
        "rel": "aYOUneAdvertisementDisplayLocations",
        "title": "MODEL_AYOUNEADVERTISEMENTDISPLAYLOCATION",
        "href": "https://api.ayoune.app/su/ayouneadvertisementdisplaylocations",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "su.ayouneadvertisementdisplaylocations"
      },
      {
        "rel": "Departments",
        "title": "MODEL_DEPARTMENT",
        "href": "https://api.ayoune.app/config/departments",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.departments"
      },
      {
        "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": "WallBoards",
        "title": "MODEL_WALLBOARD",
        "href": "https://api.ayoune.app/pm/wallboards",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "pm.wallboards"
      },
      {
        "rel": "Credentials",
        "title": "MODEL_CREDENTIAL",
        "href": "https://api.ayoune.app/config/credentials",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.credentials"
      },
      {
        "rel": "IoTDeviceBlueprints",
        "title": "MODEL_IOTDEVICEBLUEPRINT",
        "href": "https://api.ayoune.app/iot/iotdeviceblueprints",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "iot.iotdeviceblueprints"
      },
      {
        "rel": "IoTDevices",
        "title": "MODEL_IOTDEVICE",
        "href": "https://api.ayoune.app/config/iotdevices",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.iotdevices"
      }
    ],
    "debugId": "6ac70fe41f2ca7f48d9d39b4",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_IOTDEVICE",
        "href": "https://api.ayoune.app/config/iotdevices/6aa76eac8e4d941dde87f0fc/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_IOTDEVICE",
        "href": "https://api.ayoune.app/config/iotdevices/6aa76eac8e4d941dde87f0fc",
        "method": "delete",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.170.1",
      "core": "2026.367.0"
    },
    "rateLimit": {
      "limit": "10000",
      "remaining": "8680",
      "reset": "1791432105",
      "resetDate": "Thu Oct 08 2026"
    },
    "responseTime": 191.759991,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpunkte

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

SDK

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

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

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

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

Weiterführend