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 proxyPisanje skripti u alatu za izradu predložakaProject ScaffoldingMedia Library

Bez sučelja

Brzi početakSplit Screen JSON Component Builder with LLMComponent Zod Pull

REST API

Pregled REST API-jagetPovezivanje web-stranice s CMS API-jemgetGET /routesgetGET /routegetGET /blocksgetGET /blocks/with-cel-cachegetGET /blocks/generatedgetGET /componentsgetGET /components/{name}getGET /dataset/{schema_name}getGET /content-changes (SSE)patchPATCH /dataset/{schema_name}postPrijevod objavepatchPATCH /translationsgetGET /usagepostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

PATCH /dataset/{schema_name}

Umetnite ili ažurirajte varijantu dokumenta prilagođene komponente, ključenu prema id-u dokumenta.

Umetnite ili ažurirajte varijantu (redak tablice documents) prilagođene komponente, ključenu prema id dokumenta. Navedite id kako biste ažurirali postojeću varijantu; izostavite ga za umetanje nove. Dostupno i na /schemas/{schema_name}. Sadržaj se validira prema shemi komponente.

Autentikacija: API ključ — uvijek obavezan, a ključ mora imati dozvolu content_write.

Parametri putanje

ParametarVrstaObaveznoNapomene
schema_nameznakovni nizdaNaziv prilagođene komponente.

Parametri upita

ParametarVrstaObaveznoNapomene
websiteIduuidneCiljana web-stranica; u nedostatku vrijednosti koristi zaglavlje Host / konfiguraciju.
api_keyznakovni nizneAlternativa zaglavlju x-api-key.

Tijelo zahtjeva

{
  "id": "<uuid>",
  "title": "Moja varijanta",
  "content": { "title": "Pozdrav", "body": "..." }
}
PoljeVrstaObaveznoNapomene
iduuidneAžurira odgovarajuću varijantu ako postoji; umeće novu kada nedostaje ili nije pronađena.
titleznakovni niznePrikazni naslov. Zadana vrijednost pri umetanju je "Bez naslova"; pri ažuriranju ostaje nepromijenjen ako je izostavljen.
contentobjektdaVrijednosti polja, validirane prema shemi komponente. Mora biti JSON objekt.

Odgovor

{
  "id": "...",
  "schema_name": "objava",
  "title": "Moja varijanta",
  "status": "nacrt",
  "version": 2,
  "created": true
}

created je true pri umetanju (HTTP 201), a false pri ažuriranju (HTTP 200).

Primjer

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

Pogreške

  • 400 — nevažeći websiteId, content koji nije objekt, nepoznata ili arhivirana komponenta ili neuspjela validacija
  • 401 — nedostaje API ključ ili je nevažeći
  • 403 — ključ nema dozvolu content_write
  • 404 — naveden je id, ali nema odgovarajuće varijante
Continue Reading
Previous‹GET /content-changes (SSE)NextPrijevod objave›