profound-logoProfound CMS
⌘K
Admin
Theme
DocsGuidaBlogPhilosophy
DocsGuidaBlogPhilosophy

Hybrid

Instradamento parametricoTypes of ComponentsSetup server sent events (SSE) content refetchInstall Profound CMS as a proxyCEL Scripting in Template BuilderProject ScaffoldingMedia Library

Senza testa

Guida rapidaSplit Screen JSON Component Builder with LLMComponent Zod Pull

REST API

REST API OverviewgetConnect your websitegetGET /routesgetOttieni percorsogetGET /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}

Esegui un upsert di una variante di documento di un componente personalizzato, indicizzata sull'ID del documento.

Esegui un upsert di una variante (una riga documents) di un componente personalizzato, indicizzata tramite l'id del documento. Fornisci id per aggiornare una variante esistente; omettilo per inserirne una nuova. Disponibile anche su /schemas/{schema_name}. Il contenuto viene convalidato in base allo schema del componente.

Auth: chiave API — sempre obbligatoria, e la chiave deve includere l'autorizzazione content_write.

Parametri di percorso

ParamTipoObbligatorioNote
schema_namestringsìNome del componente personalizzato.

Parametri di query

ParamTipoObbligatorioNote
websiteIduuidnoSito web di destinazione; se assente si ripiega sull'intestazione / configurazione Host.
api_keystringnoAlternativa all'intestazione x-api-key.

Corpo della richiesta

{
  "id": "<uuid>",
  "title": "La mia variante",
  "content": { "title": "Ciao", "body": "..." }
}
CampoTipoObbligatorioNote
iduuidnoAggiorna la variante corrispondente quando presente; la inserisce quando è assente o non viene trovata.
titlestringnoTitolo visualizzato. Predefinito a "Untitled" in fase di inserimento; lasciato invariato durante l'aggiornamento se omesso.
contentobjectsìValori dei campi, convalidati rispetto allo schema del componente. Deve essere un oggetto JSON.

Risposta

{
  "id": "...",
  "schema_name": "post",
  "title": "La mia variante",
  "status": "draft",
  "version": 2,
  "created": true
}

created è true in caso di inserimento (HTTP 201) e false in caso di aggiornamento (HTTP 200).

Esempio

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

Errori

  • 400 — websiteId non valido, content non oggetto, componente sconosciuto o archiviato, oppure errore di convalida
  • 401 — chiave API mancante o non valida
  • 403 — la chiave non dispone dell'autorizzazione content_write
  • 404 — id fornito ma nessuna variante corrispondente
Continue Reading
Previous‹GET /content-changes (SSE)NextPOST /translation›