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.
| Param | Tipo | Obbligatorio | Note |
|---|---|---|---|
schema_name | string | sì | Nome del componente personalizzato. |
| Param | Tipo | Obbligatorio | Note |
|---|---|---|---|
websiteId | uuid | no | Sito web di destinazione; se assente si ripiega sull'intestazione / configurazione Host. |
api_key | string | no | Alternativa all'intestazione x-api-key. |
{
"id": "<uuid>",
"title": "La mia variante",
"content": { "title": "Ciao", "body": "..." }
}
| Campo | Tipo | Obbligatorio | Note |
|---|---|---|---|
id | uuid | no | Aggiorna la variante corrispondente quando presente; la inserisce quando è assente o non viene trovata. |
title | string | no | Titolo visualizzato. Predefinito a "Untitled" in fase di inserimento; lasciato invariato durante l'aggiornamento se omesso. |
content | object | sì | Valori dei campi, convalidati rispetto allo schema del componente. Deve essere un oggetto JSON. |
{
"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).
curl -X PATCH '{CMS_API_URL}/dataset/post?websiteId=<uuid>' \
-H 'x-api-key: <key>' \
-H 'Content-Type: application/json' \
-d '{"content":{"title":"Ciao"}}'
400 — websiteId non valido, content non oggetto, componente sconosciuto o archiviato, oppure errore di convalida401 — chiave API mancante o non valida403 — la chiave non dispone dell'autorizzazione content_write404 — id fornito ma nessuna variante corrispondente