Zum Inhalt springen
aYOUne
← Konfiguration API

Terminals

Singular: Terminal — 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": {
    "loc": {
      "coordinates": []
    },
    "config": {
      "autoDimMinutes": 10,
      "enableNFC": true,
      "enableSounds": true,
      "enableWedge": true,
      "screensaverMinutes": 30
    },
    "_id": "6a35ec301ab613e8ec5857f2",
    "serial": "10000000dcb55882",
    "_machines": [],
    "createdAt": "2026-06-20T01:26:08.827Z",
    "createdBy": "5a76d07e2d8b3270ff6df587",
    "isDraft": true,
    "kind": "production",
    "lastSignal": "2026-09-02T05:53:40.323Z",
    "modifiedBy": "5a76d07e2d8b3270ff6df587",
    "online": true,
    "updatedAt": "2026-09-02T05:53:40.324Z",
    "role": "production",
    "shares": []
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://config-api.ayoune.app/terminals/6a35ec301ab613e8ec5857f2",
        "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": "BuildingSpaces",
        "title": "MODEL_BUILDINGSPACE",
        "href": "https://api.ayoune.app/config/buildingspaces",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.buildingspaces"
      },
      {
        "rel": "Warehouses",
        "title": "MODEL_WAREHOUSE",
        "href": "https://api.ayoune.app/config/warehouses",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.warehouses"
      },
      {
        "rel": "Employees",
        "title": "MODEL_EMPLOYEE",
        "href": "https://api.ayoune.app/hr/employees",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "hr.employees"
      },
      {
        "rel": "DashBoards",
        "title": "MODEL_DASHBOARD",
        "href": "https://api.ayoune.app/pm/dashboards",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "pm.dashboards"
      }
    ],
    "debugId": "6ac85de2a5530da2364a8363",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_TERMINAL",
        "href": "https://api.ayoune.app/config/terminals/6a35ec301ab613e8ec5857f2/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_TERMINAL",
        "href": "https://api.ayoune.app/config/terminals/6a35ec301ab613e8ec5857f2",
        "method": "delete",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.170.1",
      "core": "2026.368.0"
    },
    "rateLimit": {
      "limit": "10000",
      "remaining": "9527",
      "reset": "1791518517",
      "resetDate": "Fri Oct 09 2026"
    },
    "responseTime": 1593.699314,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpunkte

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

SDK

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

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

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

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

Weiterführend