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 proxyCEL Scripting in Template BuilderProject ScaffoldingBibliotecă media

Fără interfață

Pornire rapidăSplit Screen JSON Component Builder with LLMComponent Zod Pull

API REST

Prezentare generală API RESTgetConnect your websitegetGET /routesgetGET /routegetGET /blocksgetObține blocuri cu cache CELgetGET /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

PATCH /dataset/{schema_name}

Introduceți sau actualizați o variantă de document a unui component personalizat, indexată după id-ul documentului.

Introduceți sau actualizați o variantă (un rând din documents) a unui component personalizat, indexată după id-ul documentului. Furnizați id pentru a actualiza o variantă existentă; omiteți-l pentru a insera una nouă. Disponibil și la /schemas/{schema_name}. Conținutul este validat în raport cu schema componentului.

Autentificare: Cheie API — întotdeauna necesară, iar cheia trebuie să dețină permisiunea content_write.

Parametri de cale

ParametruTipObligatoriuObservații
schema_namestringdaNumele componentului personalizat.

Parametri de interogare

ParametruTipObligatoriuObservații
websiteIduuidnuSite-ul țintă; se revine la antetul Host / configurație.
api_keystringnuAlternativă la antetul x-api-key.

Corpul solicitării

{
  "id": "<uuid>",
  "title": "Varianta mea",
  "content": { "title": "Salut", "body": "..." }
}
CâmpTipObligatoriuObservații
iduuidnuActualizați varianta corespunzătoare când este prezent; inserați când lipsește sau nu este găsită.
titlestringnuTitlu de afișare. Implicit "Fără titlu" la inserare; lăsat neschimbat la actualizare când este omis.
contentobjectdaValorile câmpurilor, validate în raport cu schema componentului. Trebuie să fie un obiect JSON.

Răspuns

{
  "id": "...",
  "schema_name": "post",
  "title": "Varianta mea",
  "status": "ciornă",
  "version": 2,
  "created": true
}

created este true la inserare (HTTP 201) și false la actualizare (HTTP 200).

Exemplu

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

Erori

  • 400 — websiteId invalid, content care nu este obiect, componentă necunoscută sau arhivată, sau eșec la validare
  • 401 — cheie API lipsă sau invalidă
  • 403 — cheia nu are permisiunea content_write
  • 404 — id furnizat, dar nu există nicio variantă potrivită
Continue Reading
Previous‹GET /content-changes (SSE)NextPOST /translation›