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

PATCH /dataset/{schema_name}

Lisa vÔi uuenda kohandatud komponendi dokumendivarianti, mis on seotud dokumendi ID jÀrgi.

Lisa vÔi uuenda kohandatud komponendi varianti (tabeli documents rida), mis on seotud dokumendi id jÀrgi. Sisesta id, et olemasolevat varianti uuendada; jÀta see lisamata, kui soovid luua uue. Saadaval ka aadressil /schemas/{schema_name}. Sisu valideeritakse komponendi skeemi alusel.

Autentimine: API-vĂ”ti — alati kohustuslik, ja vĂ”tmel peab olema content_write Ă”igus.

Teeparameetrid

ParameeterTĂŒĂŒpKohustuslikMĂ€rkused
schema_namestringjahKohandatud komponendi nimi.

PĂ€ringuparameetrid

ParameeterTĂŒĂŒpKohustuslikMĂ€rkused
websiteIduuideiSihtveebisait; kui see puudub, kasutatakse Host pÀist vÔi seadistust.
api_keystringeiAlternatiiv pÀisele x-api-key.

PĂ€ringu sisu

{
  "id": "<uuid>",
  "title": "Minu variant",
  "content": { "title": "Tere", "body": "..." }
}
VĂ€liTĂŒĂŒpKohustuslikMĂ€rkused
iduuideiUuendab vastava variandi, kui see on olemas; lisab uue, kui see puudub vÔi ei leitud.
titlestringeiKuvapealkiri. Lisamisel on vaikimisi "Untitled"; uuendamisel jÀÀb muutmata, kui see on vÀlja jÀetud.
contentobjectjahVÀljade vÀÀrtused, valideeritakse komponendi skeemi alusel. Peab olema JSON-objekt.

Vastus

{
  "id": "...",
  "schema_name": "post",
  "title": "Minu variant",
  "status": "mustand",
  "version": 2,
  "created": true
}

created on lisamisel true (HTTP 201) ja uuendamisel false (HTTP 200).

NĂ€ide

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

Veateated

  • 400 — vigane websiteId, mitteobjektne content, tundmatu vĂ”i arhiveeritud komponent vĂ”i valideerimisviga
  • 401 — puuduv vĂ”i vigane API-vĂ”ti
  • 403 — vĂ”tmel puudub content_write Ă”igus
  • 404 — id on antud, kuid vastavat varianti ei leitud
Continue Reading
Previousâ€čGET /content-changes (SSE)NextPOST /translationâ€ș