Zum Inhalt springen
aYOUne
← Konfiguration API

States

Singular: State — 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": {
    "_id": "6ac3ca72c0aedf1dd2db7741",
    "entityId": "6ac3c90c291ae565fd196a6b",
    "key": "ad-display-sentinel",
    "_entity": "6ac3c90c291ae565fd196a6b",
    "appName": "aYOUne",
    "attributes": {
      "kind": "active",
      "at": "2026-10-05T16:17:06.216Z",
      "source": "sentinel-worker",
      "sentAt": "2026-10-05T16:17:06.216Z"
    },
    "availableForWallboard": false,
    "createdAt": "2026-10-05T16:04:02.086Z",
    "domain": "ads",
    "environment": "kube",
    "friendlyName": "Ad-Display Schaufenster Marktplatz — Querformat sentinel",
    "group": "display-runtime",
    "isLight": false,
    "isOverTime": false,
    "isSensor": false,
    "isSwitch": false,
    "lastChanged": "2026-10-05T16:17:06.338Z",
    "modelName": "aYOUneAdvertisementDisplays",
    "nameSpace": "aYOUne",
    "postfix": "",
    "prefix": "abnahme-hotel-quer",
    "readOnly": true,
    "shares": [],
    "showOnWallboard": false,
    "state": "active",
    "unitOfMeasurement": "",
    "updatedAt": "2026-10-05T16:17:06.338Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://config-api.ayoune.app/states/6ac3ca72c0aedf1dd2db7741",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [
      {
        "rel": "Consumers",
        "title": "MODEL_CONSUMER",
        "href": "https://api.ayoune.app/crm/consumers",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "crm.consumers"
      },
      {
        "rel": "Events",
        "title": "MODEL_EVENT",
        "href": "https://api.ayoune.app/automation/events",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "automation.events"
      },
      {
        "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": "Credentials",
        "title": "MODEL_CREDENTIAL",
        "href": "https://api.ayoune.app/config/credentials",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.credentials"
      }
    ],
    "debugId": "6ac9afa2cdeaf426c1097c07",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_STATE",
        "href": "https://api.ayoune.app/config/states/6ac3ca72c0aedf1dd2db7741/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_STATE",
        "href": "https://api.ayoune.app/config/states/6ac3ca72c0aedf1dd2db7741",
        "method": "delete",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.170.1",
      "core": "2026.368.0"
    },
    "rateLimit": {
      "limit": "10000",
      "remaining": "9965",
      "reset": "1791604919",
      "resetDate": "Sat Oct 10 2026"
    },
    "responseTime": 388.220742,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpunkte

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

SDK

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

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

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

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

Weiterführend