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 proxySkriptovanie v nástroji na tvorbu šablónProject ScaffoldingKnižnica médií

Headless

Rýchly štartSplit Screen JSON Component Builder with LLMComponent Zod Pull

REST API

Prehľad REST APIgetConnect your websitegetZískanie trásgetZískanie trasygetZískaj blokygetGET /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}

Vykonajte operáciu upsert pre variant dokumentu vlastného komponentu identifikovaný podľa ID dokumentu.

Vykonajte operáciu upsert pre variant (riadok documents) vlastného komponentu, identifikovaný podľa id dokumentu. Zadajte id, ak chcete aktualizovať existujúci variant; vynechajte ho, ak chcete vložiť nový. Dostupné aj na /schemas/{schema_name}. Obsah sa validuje podľa schémy komponentu.

Autorizácia: API kľúč — vždy povinný a kľúč musí mať oprávnenie content_write.

Parametre cesty

ParameterTypPovinnéPoznámky
schema_namestringánoNázov vlastného komponentu.

Parametre dotazu

ParameterTypPovinnéPoznámky
websiteIduuidnieCieľová webová lokalita; inak sa použije hlavička / konfigurácia Host.
api_keystringnieAlternatíva k hlavičke x-api-key.

Telo požiadavky

{
  "id": "<uuid>",
  "title": "Môj variant",
  "content": { "title": "Ahoj", "body": "..." }
}
PoleTypPovinnéPoznámky
iduuidnieAktualizuje zodpovedajúci variant, ak je prítomné; vloží, ak chýba alebo sa nenašlo.
titlestringnieZobrazený názov. Pri vkladaní je predvolená hodnota "Untitled"; pri aktualizácii zostane nezmenený, ak je vynechaný.
contentobjectánoHodnoty polí, validované podľa schémy komponentu. Musí ísť o objekt JSON.

Odpoveď

{
  "id": "...",
  "schema_name": "post",
  "title": "Môj variant",
  "status": "koncept",
  "version": 2,
  "created": true
}

created je true pri vložení (HTTP 201) a false pri aktualizácii (HTTP 200).

Príklad

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

Chyby

  • 400 — neplatné websiteId, neobjektové content, neznámy alebo archivovaný komponent alebo zlyhanie validácie
  • 401 — chýbajúci alebo neplatný API kľúč
  • 403 — kľúč nemá oprávnenie content_write
  • 404 — id je dodané, ale chýba zodpovedajúci variant
Continue Reading
Previous‹GET /content-changes (SSE)NextPOST /translation›