aYOUne
← planning API

PlanningModels

Singular: PlanningModel — Base-URL: https://planning-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": "6a6198313b41dde1f134e522",
    "name": "EVOLUTIONARY_TAN_ROOS TARPALS",
    "createdBy": "6045f4d25704710012485569",
    "createdAt": "2026-07-23T04:27:29.258Z",
    "updatedAt": "2026-07-23T04:27:29.258Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://planning-api.ayoune.app/planningmodels/6a6198313b41dde1f134e522",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [],
    "debugId": "6a6198323b41dde1f134e54e",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_PLANNINGMODEL",
        "href": "https://api.ayoune.app/planning/planningmodels/6a6198313b41dde1f134e522/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_PLANNINGMODEL",
        "href": "https://api.ayoune.app/planning/planningmodels/6a6198313b41dde1f134e522/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.20.0",
      "core": "2026.257.1"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "2459",
      "reset": "1784784442",
      "resetDate": "Thu Jul 23 2026"
    },
    "responseTime": 37.274127,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpunkte

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

SDK

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

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

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

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

Weiterführend