profound-logoProfound CMS
⌘K
Admin
Theme
DokumenteTutorialBlogPhilosophie
DokumenteTutorialBlogPhilosophie

Hybrid

Parametrisches RoutingKomponenten-TypenSetup server sent events (SSE) content refetchEinrichtung-Admin-Panel-ProxyScripting im Template-BuilderProject ScaffoldingMedienbibliothek

Headless

SchnellstartSplit Screen JSON Component Builder with LLMComponent Zod Pull

REST-API

REST API OverviewgetWebsite mit der CMS-API verbindengetRouten abrufengetRoute abrufengetBlöcke abrufengetBlöcke mit CEL-Cache abrufengetGET /blocks/generatedgetKomponenten abrufengetKomponentenname abrufengetGET /dataset/{schema_name}getGET /content-changes (SSE)patchPATCH /dataset/{schema_name}postNachbearbeitung der ÜbersetzungpatchPatch-ÜbersetzungengetNutzung abrufenpostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

Komponentenname abrufen

Rufen Sie die vollständige Felddefinition einer einzelnen benutzerdefinierten Komponente anhand ihres Namens ab.

Rufen Sie die vollständige Definition einer einzelnen benutzerdefinierten Komponente anhand ihres Namens ab, einschließlich der Feldliste.

Authentifizierung: API-Schlüssel (x-api-key-Header oder api_key-Abfrageparameter).

Pfadparameter

ParameterTypErforderlichHinweise
namestringjaDer Schemaname, z. B. beitrag.

Abfrageparameter

ParameterTypErforderlichHinweise
websiteIduuidjaMuss eine gültige UUID sein.
api_keystringneinAlternative zum Header x-api-key.

Antwort

{
  "id": "...",
  "name": "beitrag",
  "displayName": "Beitrag",
  "description": "Ein Dokumentationsbeitrag",
  "category": "Benutzerdefiniert",
  "titleField": "titel",
  "routeSlugField": "titel",
  "icon": null,
  "fields": [
    { "name": "titel", "type": "String", "required": true }
  ],
  "slugFields": ["titel", "beschreibung"],
  "version": 8
}

slugFields wird berechnet — die Namen aller Felder mit dem Typ String.

Beispiel

curl '{CMS_API_URL}/components/beitrag?websiteId=<uuid>' \
  -H 'x-api-key: <key>'

Fehler

  • 400 — fehlende oder ungültige websiteId
  • 401 — ungültiger API-Schlüssel
  • 404 — Schema nicht gefunden
Continue Reading
Previous‹Komponenten abrufenNextGET /dataset/{schema_name}›