Įterpkite arba atnaujinkite tinkinto komponento dokumento variantą, susietą su dokumento `id`.
Įkelkite arba atnaujinkite variantą (lentelės documents eilutę) tinkintame komponente, identifikuojamą pagal dokumento id. Pateikite id, kad atnaujintumėte esamą variantą; jį praleiskite, jei norite įterpti naują. Taip pat prieinama adresu /schemas/{schema_name}. Turinys tikrinamas pagal komponento schemą.
Autentifikacija: API raktas — visada privalomas, ir raktas turi turėti leidimą content_write.
| Parametras | Tipas | Privalomas | Pastabos |
|---|---|---|---|
schema_name | string | taip | Tinkinto komponento pavadinimas. |
| Parametras | Tipas | Privalomas | Pastabos |
|---|---|---|---|
websiteId | uuid | ne | Tikslinė svetainė; jei nenurodyta, naudojama Host antraštė / konfigūracija. |
api_key | string | ne | Alternatyva antraštei x-api-key. |
{
"id": "<uuid>",
"title": "My variant",
"content": { "title": "Hello", "body": "..." }
}
| Laukas | Tipas | Privalomas | Pastabos |
|---|---|---|---|
id | uuid | ne | Atnaujina atitinkantį variantą, jei pateiktas; įterpia, jei nėra arba nerastas. |
title | string | ne | Rodomas pavadinimas. Įterpiant numatytasis — "Untitled"; atnaujinant neliečiamas, jei praleistas. |
content | object | taip | Laukų reikšmės, tikrinamos pagal komponento schemą. Privalo būti JSON objektas. |
{
"id": "...",
"schema_name": "post",
"title": "My variant",
"status": "draft",
"version": 2,
"created": true
}
created reikšmė true įterpimo metu (HTTP 201), o atnaujinant — 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":"Hello"}}'
400 — neteisingas websiteId, neobjektinis content, nežinomas arba archyvuotas komponentas arba tikrinimo klaida401 — trūksta arba neteisingas API raktas403 — raktas neturi leidimo content_write404 — pateiktas id, bet atitinkamas variantas nerastas