profound-logoProfound CMS
⌘K
Admin
Theme
DocsTutorialBlogPhilosophy
DocsTutorialBlogPhilosophy

Hybrid

Collection of Pages with ComponentsTypes of ComponentsSetup server sent events (SSE) content refetchInstall Profound CMS as a proxySzkriptelés a sablonkészítőbenProject ScaffoldingMédiatár

Fej nélküli

Quick startJSON és Claude kódComponent Zod Pull

REST API

REST API áttekintésgetConnect your websitegetGET /routesgetÚtvonal feloldásagetBlokkok lekérésegetGET /blocks/with-cel-cachegetGenerált blokkok lekérésegetKomponensek lekérésegetGET /components/{name}getAdatkészlet-séma nevének lekérésegetGET /content-changes (SSE)patchPATCH /dataset/{schema_name}postUtólagos fordításpatchFordítások javításagetGET /usagepostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

PATCH /dataset/{schema_name}

Hozzon létre vagy frissítsen egy egyedi komponens dokumentumvariánst, a dokumentumazonosító alapján kulcsolva.

Hozzon létre vagy frissítsen egy egyedi komponens variánst (egy documents sor), a dokumentum id értéke alapján kulcsolva. Adja meg az id-t egy meglévő variáns frissítéséhez; hagyja el, ha újat szeretne beszúrni. Elérhető a /schemas/{schema_name} végponton is. A tartalmat a komponens sémája ellenőrzi.

Hitelesítés: API-kulcs — mindig kötelező, és a kulcsnak rendelkeznie kell a content_write jogosultsággal.

Útvonalparaméterek

ParaméterTípusKötelezőMegjegyzések
schema_namestringigenAz egyedi komponens neve.

Lekérdezési paraméterek

ParaméterTípusKötelezőMegjegyzések
websiteIduuidnemCélwebhely; alapértelmezésként a Host fejlécet / konfigurációt használja.
api_keystringnemAlternatívája az x-api-key fejlécnek.

Kérelem törzse

{
  "id": "<uuid>",
  "title": "Saját variáns",
  "content": { "title": "Helló", "body": "..." }
}
MezőTípusKötelezőMegjegyzések
iduuidnemFrissíti a megfelelő variánst, ha jelen van; beszúrja, ha hiányzik vagy nem található.
titlestringnemMegjelenített cím. Beszúráskor alapértelmezés szerint "Untitled"; frissítéskor változatlan marad, ha kihagyja.
contentobjectigenMezőértékek, amelyeket a komponens sémája ellenőriz. JSON-objektumnak kell lennie.

Válasz

{
  "id": "...",
  "schema_name": "post",
  "title": "Saját variáns",
  "status": "vázlat",
  "version": 2,
  "created": true
}

A created értéke beszúráskor true (HTTP 201), frissítéskor false (HTTP 200).

Példa

curl -X PATCH '{CMS_API_URL}/dataset/post?websiteId=<uuid>' \
  -H 'x-api-key: <key>' \
  -H 'Content-Type: application/json' \
  -d '{"content":{"title":"Helló"}}'

Hibák

  • 400 — érvénytelen websiteId, nem objektum típusú content, ismeretlen vagy archivált komponens, illetve validációs hiba
  • 401 — hiányzó vagy érvénytelen API-kulcs
  • 403 — a kulcs nem rendelkezik content_write jogosultsággal
  • 404 — id megadva, de nincs egyező variáns
Continue Reading
Previous‹GET /content-changes (SSE)NextUtólagos fordítás›