aYOUne
← planning API

PlanningTemplates

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

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": "6a61983c3b41dde1f134e78c",
    "name": "ACTIVE_JADE_DUD BOLT",
    "active": false,
    "createdBy": "6045f4d25704710012485569",
    "createdAt": "2026-07-23T04:27:40.251Z",
    "updatedAt": "2026-07-23T04:27:40.251Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://planning-api.ayoune.app/planningtemplates/6a61983c3b41dde1f134e78c",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [],
    "debugId": "6a72c0dc47e626d9d1ded8cc",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_PLANNINGTEMPLATE",
        "href": "https://api.ayoune.app/planning/planningtemplates/6a61983c3b41dde1f134e78c/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_PLANNINGTEMPLATE",
        "href": "https://api.ayoune.app/planning/planningtemplates/6a61983c3b41dde1f134e78c/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.20.0",
      "core": "2026.258.0"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "2426",
      "reset": "1785908958",
      "resetDate": "Wed Aug 05 2026"
    },
    "responseTime": 291.147312,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpunkte

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

SDK

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

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

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

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

Weiterführend