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 proxyScripts dans le générateur de modèlesProject ScaffoldingBibliothèque multimédia

Sans interface

Démarrage rapideSplit Screen JSON Component Builder with LLMComponent Zod Pull

API REST

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}postPOST /translationpatchPATCH /translationsgetGET /usagepostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

PATCH /dataset/{schema_name}

Insérez ou mettez à jour une variante de document d’un composant personnalisé, indexée sur l’identifiant du document.

Insérez ou mettez à jour une variante (une ligne documents) d’un composant personnalisé, indexée sur l’id du document. Fournissez l’id pour mettre à jour une variante existante ; omettez-le pour en insérer une nouvelle. Également disponible à /schemas/{schema_name}. Le contenu est validé par rapport au schéma du composant.

Auth : clé API — toujours requise, et la clé doit disposer de l’autorisation content_write.

Paramètres de chemin

ParamètreTypeObligatoireRemarques
schema_namestringouiLe nom du composant personnalisé.

Paramètres de requête

ParamètreTypeObligatoireRemarques
websiteIduuidnonSite web cible ; se replie sur l’en-tête/configuration Host.
api_keystringnonAlternative à l’en-tête x-api-key.

Corps de la requête

{
  "id": "<uuid>",
  "title": "Ma variante",
  "content": { "title": "Bonjour", "body": "..." }
}
ChampTypeObligatoireRemarques
iduuidnonMet à jour la variante correspondante lorsqu’elle est présente ; l’insère lorsqu’elle est absente ou introuvable.
titlestringnonTitre affiché. Défaut à "Sans titre" lors de l’insertion ; reste inchangé lors de la mise à jour si omis.
contentobjectouiValeurs des champs, validées par rapport au schéma du composant. Doit être un objet JSON.

Réponse

{
  "id": "...",
  "schema_name": "post",
  "title": "Ma variante",
  "status": "brouillon",
  "version": 2,
  "created": true
}

created vaut true lors de l’insertion (HTTP 201) et false lors de la mise à jour (HTTP 200).

Exemple

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

Erreurs

  • 400 — websiteId invalide, content non objet, composant inconnu ou archivé, ou échec de validation
  • 401 — clé API manquante ou invalide
  • 403 — clé dépourvue de l’autorisation content_write
  • 404 — id fourni mais aucune variante correspondante
Continue Reading
Previous‹GET /content-changes (SSE)NextPOST /translation›