Izveidojiet vai atjauniniet pielāgota komponenta dokumenta variantu, kas identificēts pēc dokumenta ID.
Veiciet pielāgota komponenta varianta (tabulas documents rindas) izveidi vai atjaunināšanu, identificējot to pēc dokumenta id. Norādiet id, lai atjauninātu esošu variantu; izlaidiet to, lai ievietotu jaunu. Pieejams arī vietnē /schemas/{schema_name}. Saturs tiek validēts atbilstoši komponenta shēmai.
Autentifikācija: API atslēga — vienmēr obligāti, un atslēgai jābūt ar atļauju content_write.
| Parametrs | Tips | Obligāts | Piezīmes |
|---|---|---|---|
schema_name | virkne | jā | Pielāgotā komponenta nosaukums. |
| Parametrs | Tips | Obligāts | Piezīmes |
|---|---|---|---|
websiteId | uuid | nē | Mērķa vietne; izmanto Host galveni / konfigurāciju, ja nav norādīts. |
api_key | virkne | nē | Alternatīva galvenei x-api-key. |
{
"id": "<uuid>",
"title": "Mans variants",
"content": { "title": "Sveiki", "body": "..." }
}
| Lauks | Tips | Obligāts | Piezīmes |
|---|---|---|---|
id | uuid | nē | Ja norādīts, atjaunina atbilstošo variantu; ja trūkst vai nav atrasts, ievieto jaunu. |
title | virkne | nē | Parādāmais nosaukums. Ievietošanas laikā pēc noklusējuma ir "Untitled"; atjauninot, netiek mainīts, ja izlaists. |
content | objekts | jā | Lauku vērtības, kas tiek validētas pret komponenta shēmu. Jābūt JSON objektam. |
{
"id": "...",
"schema_name": "ieraksts",
"title": "Mans variants",
"status": "melnraksts",
"version": 2,
"created": true
}
created ir true ievietošanas laikā (HTTP 201) un false atjaunināšanas laikā (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":"Sveiki"}}'
400 — nederīgs websiteId, content nav objekts, nezināms vai arhivēts komponents, vai validācijas kļūme401 — trūkstoša vai nederīga API atslēga403 — atslēgai nav atļaujas content_write404 — norādīts id, taču atbilstošs variants nav atrasts