Zum Inhalt springen
aYOUne
← Konfiguration API

DocumentRenders

Singular: DocumentRender — Base-URL: https://config-api.ayoune.app — Zugriff: read-only — 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": "6a72ab2d6a999f58dc5b0d97",
    "_sourceEntityID": "6a701d0f83acdef8be6652cb",
    "sourceEntityType": "Invoices",
    "idempotencyKey": "Invoices:6a701d0f83acdef8be6652cb:default:pdf:0",
    "renderedAt": "2026-08-05T03:17:01.974Z",
    "outputFormat": "pdf",
    "requestedBy": "5a76d07e2d8b3270ff6df587",
    "status": "pending",
    "meta": {
      "locale": "de-DE",
      "requestSource": "actionInvoicePrint"
    },
    "isDraft": true,
    "createdAt": "2026-08-05T03:17:01.975Z",
    "updatedAt": "2026-08-05T03:17:01.975Z",
    "shares": []
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://config-api.ayoune.app/documentrenders/6a72ab2d6a999f58dc5b0d97",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [
      {
        "rel": "DocumentTemplates",
        "title": "MODEL_DOCUMENTTEMPLATE",
        "href": "https://api.ayoune.app/config/documenttemplates",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.documenttemplates"
      }
    ],
    "debugId": "6ac85ddaa5530da2364a8277",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_DOCUMENTRENDER",
        "href": "https://api.ayoune.app/config/documentrenders/6a72ab2d6a999f58dc5b0d97/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_DOCUMENTRENDER",
        "href": "https://api.ayoune.app/config/documentrenders/6a72ab2d6a999f58dc5b0d97",
        "method": "delete",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.170.1",
      "core": "2026.368.0"
    },
    "rateLimit": {
      "limit": "10000",
      "remaining": "9544",
      "reset": "1791518517",
      "resetDate": "Fri Oct 09 2026"
    },
    "responseTime": 312.858351,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpunkte

MethodePathBeschreibungRight
GET /documentrenders Liste mit Filtern/Paginierung config.documentrenders.view
GET /documentrenders/:id Einzelner Datensatz via ID config.documentrenders.view

SDK

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

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

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

Weiterführend