aYOUne
← Projektmanagement API

WallBoards

Singular: WallBoard — Base-URL: https://pm-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": {
    "general": {
      "showHeader": true,
      "showTabs": true,
      "showDate": true,
      "showCalWeek": true,
      "showTime": true,
      "showOnlineStatus": false,
      "showTunnelStatus": false,
      "showTimeTracker": true,
      "showTimeRemainingBar": false,
      "showRemainingTimeTillFullReload": false,
      "showDataLoadingIndicator": false,
      "showStates": false,
      "showStateLabels": false,
      "invertLogo": false,
      "chartsColorTheme": "natural"
    },
    "visionboardOnLock": false,
    "visionboardBindingSource": "personal",
    "allowLock": false,
    "alertsHidden": false,
    "alertDisplayMode": "banner",
    "_id": "65e0b19b121b7d48fe159bc0",
    "active": false,
    "companyDashboard": false,
    "theme": "ayoune-light",
    "allowCast": true,
    "allowWelcomeScreen": true,
    "showDebug": false,
    "createdBy": "6045f4d25704710012485569",
    "access_key": "M0VVyMQzBTVSZJfgYF1gQ2LnKNOnd2ddgdezgEbPCmz3ZsSjPn9N8dYMunsxTLFm6ApTC88SZ2WdgMdwI9cBIFyTfrnivBXpzA7giDGL8bZOqNyo6luTV3DcKdjIkEDEjJitpIFfVFoqplg63c6pLVkWSsXDjOwOPgHmSfuwJfoqSyB8oKy6B0s97WeuMlv1cU6r0KNwxRUVuFUJyU3XHSeGBUzvYRlorAwk4SPSVqdKQ6r9NJQbcZUJTiY3Jeaa",
    "states": [],
    "views": [],
    "createdAt": "2024-02-29T16:32:27.276Z",
    "updatedAt": "2024-02-29T16:32:27.276Z",
    "visionBoard": []
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://pm-api.ayoune.app/wallboards/65e0b19b121b7d48fe159bc0",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [
      {
        "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": "WorkCenters",
        "title": "MODEL_WORKCENTER",
        "href": "https://api.ayoune.app/production/workcenters",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "production.workcenters"
      },
      {
        "rel": "CallContextLayouts",
        "title": "MODEL_CALLCONTEXTLAYOUT",
        "href": "https://api.ayoune.app/pm/callcontextlayouts",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "pm.callcontextlayouts"
      }
    ],
    "debugId": "6a61987af0cde3e459455c7b",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_WALLBOARD",
        "href": "https://api.ayoune.app/pm/wallboards/65e0b19b121b7d48fe159bc0/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_WALLBOARD",
        "href": "https://api.ayoune.app/pm/wallboards/65e0b19b121b7d48fe159bc0/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.34.0",
      "core": "2026.257.1"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "2197",
      "reset": "1784784467",
      "resetDate": "Thu Jul 23 2026"
    },
    "responseTime": 112.302329,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpunkte

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

SDK

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

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

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

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

Weiterführend