aYOUne
← Konfiguration API

TextBlocks

Singular: TextBlock — Base-URL: https://config-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": "65e0b07e121b7d48fe15819e",
    "name": "-",
    "slug": "-",
    "format": "plaintext",
    "createdBy": "6045f4d25704710012485569",
    "createdAt": "2024-02-29T16:27:42.819Z",
    "updatedAt": "2024-02-29T16:27:42.819Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://config-api.ayoune.app/textblocks/65e0b07e121b7d48fe15819e",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [
      {
        "rel": "TemplateGroups",
        "title": "MODEL_TEMPLATEGROUP",
        "href": "https://api.ayoune.app/config/templategroups",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.templategroups"
      }
    ],
    "debugId": "6a62def3f27d6098834b1b1a",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_TEXTBLOCK",
        "href": "https://api.ayoune.app/config/textblocks/65e0b07e121b7d48fe15819e/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_TEXTBLOCK",
        "href": "https://api.ayoune.app/config/textblocks/65e0b07e121b7d48fe15819e/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.95.0",
      "core": "2026.258.0"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "369",
      "reset": "1784865648",
      "resetDate": "Fri Jul 24 2026"
    },
    "responseTime": 195.446188,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpunkte

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

SDK

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

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

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

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

Weiterführend