aYOUne
← Konfiguration API

ConfiguratorFields

Singular: ConfiguratorField — 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": {
    "settings": {
      "min": 0,
      "max": 10000000,
      "step": 0,
      "unit": "",
      "family": "",
      "slider": false,
      "charlimit": -1,
      "useFileTemplate": false,
      "filetemplatekind": "static"
    },
    "_id": "65ce12d8e5aa4ba0ba5e2974",
    "name": "",
    "field": "",
    "confname": "",
    "portalname_en": "",
    "so": 0,
    "type": "text",
    "readonly": false,
    "help": "",
    "calculated": false,
    "formula": "",
    "placeholder": "",
    "databinding": false,
    "databindingEntity": "",
    "databindingLimit": 0,
    "functionBeforeSave": "none",
    "functionBeforeSaveParam": "",
    "definesMatching": false,
    "createdBy": "6045f4d25704710012485569",
    "values": [],
    "createdAt": "2024-02-15T13:34:16.617Z",
    "updatedAt": "2024-02-15T13:34:16.617Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://config-api.ayoune.app/configuratorfields/65ce12d8e5aa4ba0ba5e2974",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [
      {
        "rel": "Attachments",
        "title": "MODEL_ATTACHMENT",
        "href": "https://api.ayoune.app/config/attachments",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.attachments"
      }
    ],
    "debugId": "6a62dd0f30b7d778029e6b59",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_CONFIGURATORFIELD",
        "href": "https://api.ayoune.app/config/configuratorfields/65ce12d8e5aa4ba0ba5e2974/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_CONFIGURATORFIELD",
        "href": "https://api.ayoune.app/config/configuratorfields/65ce12d8e5aa4ba0ba5e2974/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.94.0",
      "core": "2026.258.0"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "2125",
      "reset": "1784865648",
      "resetDate": "Fri Jul 24 2026"
    },
    "responseTime": 180.151321,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpunkte

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

SDK

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

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

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

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

Weiterführend