Vloží nebo aktualizuje variantu dokumentu vlastní komponenty, identifikovanou podle ID dokumentu.
Vložte nebo aktualizujte variantu (řádek documents) vlastní komponenty, identifikovanou podle id dokumentu. Uveďte id, chcete-li aktualizovat existující variantu; vynechejte jej pro vložení nové. K dispozici také na /schemas/{schema_name}. Obsah je validován podle schématu komponenty.
Autorizace: Klíč API — vždy povinný a musí mít oprávnění content_write.
| Parametr | Typ | Povinné | Poznámky |
|---|---|---|---|
schema_name | string | ano | Název vlastní komponenty. |
| Parametr | Typ | Povinné | Poznámky |
|---|---|---|---|
websiteId | uuid | ne | Cílový web; případně se použije hlavička Host / konfigurace. |
api_key | string | ne | Alternativa k hlavičce x-api-key. |
{
"id": "<uuid>",
"title": "Moje varianta",
"content": { "title": "Ahoj", "body": "..." }
}
| Pole | Typ | Povinné | Poznámky |
|---|---|---|---|
id | uuid | ne | Pokud je zadáno, aktualizuje odpovídající variantu; pokud chybí nebo nebyla nalezena, vloží novou. |
title | string | ne | Zobrazovaný název. Při vložení se výchozí hodnota nastaví na "Untitled"; při aktualizaci zůstává beze změny, pokud je vynechán. |
content | object | ano | Hodnoty polí, validované podle schématu komponenty. Musí být objekt JSON. |
{
"id": "...",
"schema_name": "post",
"title": "Moje varianta",
"status": "koncept",
"version": 2,
"created": true
}
created je při vložení true (HTTP 201) a při aktualizaci false (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":"Ahoj"}}'
400 — neplatné websiteId, content, které není objektem, neznámá nebo archivovaná komponenta, nebo chyba validace401 — chybějící nebo neplatný klíč API403 — klíči chybí oprávnění content_write404 — id bylo zadáno, ale neexistuje odpovídající varianta