profound-logoProfound CMS
⌘K
Admin
Theme
DocsTutorialBlogPhilosophy
DocsTutorialBlogPhilosophy

Hybrid

Collection of Pages with ComponentsKomponenttyperSetup server sent events (SSE) content refetchInstall Profound CMS as a proxyScripting i skabelonbyggerenProject ScaffoldingMediebibliotek

Headless

HurtigstartSplit Screen JSON Component Builder with LLMComponent Zod Pull

REST API

REST API-oversigtgetConnect your websitegetGET /routesgetGET /routegetGET /blocksgetGET /blocks/with-cel-cachegetGET /blocks/generatedgetGET /componentsgetGET /components/{name}getGET /dataset/{schema_name}getGET /content-changes (SSE)patchPATCH /dataset/{schema_name}postPOST /translationpatchPATCH /translationsgetGET /usagepostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

GET /components/{name}

Hent den fulde feltdefinition for en enkelt brugerdefineret komponent efter navn.

Hent den fulde definition af en enkelt brugerdefineret komponent efter navn, inklusive dens feltliste.

Godkendelse: API-nøgle (x-api-key-header eller api_key-forespørgselsparameter).

Sti-parametre

ParameterTypePåkrævetBemærkninger
namestringjaSkemanavnet, f.eks. post.

Forespørgselsparametre

ParameterTypePåkrævetBemærkninger
websiteIduuidjaSkal være en gyldig UUID.
api_keystringnejAlternativ til x-api-key-headeren.

Svar

{
  "id": "...",
  "name": "post",
  "displayName": "Indlæg",
  "description": "Et dokumentationsindlæg",
  "category": "Brugerdefineret",
  "titleField": "titel",
  "routeSlugField": "titel",
  "icon": null,
  "fields": [
    { "name": "titel", "type": "string", "required": true }
  ],
  "slugFields": ["titel", "beskrivelse"],
  "version": 8
}

slugFields beregnes — navnene på alle felter af typen string.

Eksempel

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

Fejl

  • 400 — manglende eller ugyldig websiteId
  • 401 — ugyldig API-nøgle
  • 404 — skema ikke fundet
Continue Reading
Previous‹GET /componentsNextGET /dataset/{schema_name}›