Wstaw lub zaktualizuj wariant dokumentu niestandardowego komponentu, identyfikowany po identyfikatorze dokumentu.
Wstaw lub zaktualizuj wariant (wiersz w tabeli documents) niestandardowego komponentu, identyfikowany po id dokumentu. Podaj id, aby zaktualizować istniejący wariant; pomiń je, aby wstawić nowy. Dostępne również pod adresem /schemas/{schema_name}. Zawartość jest walidowana względem schematu komponentu.
Uwierzytelnianie: Klucz API — zawsze wymagany, a klucz musi mieć uprawnienie content_write.
| Parametr | Typ | Wymagane | Uwagi |
|---|---|---|---|
schema_name | string | tak | Nazwa niestandardowego komponentu. |
| Parametr | Typ | Wymagane | Uwagi |
|---|---|---|---|
websiteId | uuid | nie | Docelowa witryna; w razie braku używa nagłówka Host / konfiguracji. |
api_key | string | nie | Alternatywa dla nagłówka x-api-key. |
{
"id": "<uuid>",
"title": "Mój wariant",
"content": { "title": "Witaj", "body": "..." }
}
| Pole | Typ | Wymagane | Uwagi |
|---|---|---|---|
id | uuid | nie | Zaktualizuje pasujący wariant, jeśli występuje; wstawi, gdy go brakuje lub nie zostanie znaleziony. |
title | string | nie | Tytuł wyświetlany. Domyślnie "Untitled" podczas wstawiania; pozostaje bez zmian przy aktualizacji, jeśli pominięty. |
content | object | tak | Wartości pól, walidowane względem schematu komponentu. Musi być obiektem JSON. |
{
"id": "...",
"schema_name": "post",
"title": "Mój wariant",
"status": "szkic",
"version": 2,
"created": true
}
created ma wartość true przy wstawianiu (HTTP 201) i false przy aktualizacji (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":"Witaj"}}'
400 — nieprawidłowe websiteId, zawartość content niebędąca obiektem, nieznany lub zarchiwizowany komponent albo błąd walidacji401 — brakujący lub nieprawidłowy klucz API403 — klucz nie ma uprawnienia content_write404 — podano id, ale nie znaleziono pasującego wariantu