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 proxySkripting i malbyggerenProject ScaffoldingMedia Library

Headless

Quick startSplit Screen JSON Component Builder with LLMComponent Zod Pull

REST API

REST API OverviewgetConnect your websitegetGET /routesgetGET /routegetGET /blocksgetGET /blocks/with-cel-cachegetGET /blocks/generatedgetGET /componentsgetGET /components/{name}getGET /dataset/{schema_name}getGET /content-changes (SSE)patchPATCH /dataset/{schema_name}postEtteroversettelsepatchPATCH /translationsgetGET /usagepostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

PATCH /dataset/{schema_name}

Oppdater eller sett inn en dokumentvariant av en egendefinert komponent, nĂžkkelsatt etter dokumentets id.

Oppdater eller sett inn en variant (en documents-rad) av en egendefinert komponent, nÞkkelsatt etter dokumentets id. Oppgi id for Ä oppdatere en eksisterende variant; utelat den for Ä sette inn en ny. OgsÄ tilgjengelig pÄ /schemas/{schema_name}. Innholdet blir validert mot komponentens skjema.

Autentisering: API-nĂžkkel — alltid pĂ„krevd, og nĂžkkelen mĂ„ ha tillatelsen content_write.

Sti-parametere

ParameterTypePÄkrevdMerknader
schema_namestringjaNavnet pÄ den egendefinerte komponenten.

ForespĂžrselsparametere

ParameterTypePÄkrevdMerknader
websiteIduuidneiMÄlnettsted; faller tilbake til Host-header / konfigurasjon.
api_keystringneiAlternativ til x-api-key-headeren.

ForespĂžrselstekst

{
  "id": "<uuid>",
  "title": "Varianten min",
  "content": { "title": "Hei", "body": "..." }
}
FeltTypePÄkrevdMerknader
iduuidneiOppdater den tilsvarende varianten nÄr den finnes; sett inn nÄr den mangler eller ikke blir funnet.
titlestringneiVisningstittel. Standardverdi er \"Uten tittel\" ved innsetting; forblir uendret ved oppdatering nÄr den utelates.
contentobjectjaFeltverdier, validert mot komponentens skjema. MĂ„ vĂŠre et JSON-objekt.

Respons

{
  "id": "...",
  "schema_name": "post",
  "title": "Varianten min",
  "status": "utkast",
  "version": 2,
  "created": true
}

created er true ved innsetting (HTTP 201) og false ved oppdatering (HTTP 200).

Eksempel

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

Feil

  • 400 — ugyldig websiteId, content som ikke er et objekt, ukjent eller arkivert komponent, eller valideringsfeil
  • 401 — manglende eller ugyldig API-nĂžkkel
  • 403 — nĂžkkelen mangler tillatelsen content_write
  • 404 — id oppgitt, men ingen samsvarende variant
Continue Reading
Previousâ€čGET /content-changes (SSE)NextEtteroversettelseâ€ș