profound-logoProfound CMS
⌘K
Admin
Theme
DocsTutorialBlogPhilosophy
DocsTutorialBlogPhilosophy

Hybrid

Collection of Pages with ComponentsTypes of ComponentsSetup server sent events (SSE) content refetchAdminipaneeli puhverserveri seadistamineCEL Scripting in Template BuilderProject ScaffoldingMedia Library

Headless

KiirkÀivitusSplit Screen JSON Component Builder with LLMComponent Zod Pull

RESTi API

REST API OverviewgetConnect your websitegetMarsruutide hankiminegetGET /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}

Hangi ĂŒhe kohandatud komponendi tĂ€ielik vĂ€ljade definitsioon nime jĂ€rgi.

Hangi ĂŒhe kohandatud komponendi tĂ€ielik definitsioon nime jĂ€rgi, kaasa arvatud selle vĂ€ljade loend.

Autentimine: API-vÔti (x-api-key pÀis vÔi api_key pÀringu parameeter).

Teeparameetrid

ParameeterTĂŒĂŒpNĂ”utavMĂ€rkused
namestringjahSkeemi nimi, nt post.

PĂ€ringuparameetrid

ParameeterTĂŒĂŒpNĂ”utavMĂ€rkused
websiteIduuidjahPeab olema kehtiv UUID.
api_keystringeiAlternatiiv x-api-key pÀisele.

Vastus

{
  "id": "...",
  "name": "post",
  "displayName": "Postitus",
  "description": "Dokumentatsiooni postitus",
  "category": "Kohandatud",
  "titleField": "title",
  "routeSlugField": "title",
  "icon": null,
  "fields": [
    { "name": "title", "type": "string", "required": true }
  ],
  "slugFields": ["title", "description"],
  "version": 8
}

slugFields arvutatakse — kĂ”igi stringitĂŒĂŒpi vĂ€ljade nimed.

NĂ€ide

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

Veateated

  • 400 — websiteId puudub vĂ”i on vigane
  • 401 — vigane API-vĂ”ti
  • 404 — skeemi ei leitud
Continue Reading
Previousâ€čGET /componentsNextGET /dataset/{schema_name}â€ș