Lakukan upsert terhadap varian dokumen dari komponen kustom, yang diindeks menggunakan id dokumen.
Lakukan upsert terhadap sebuah varian (baris documents) dari komponen kustom, yang diindeks menggunakan id dokumen. Berikan id untuk memperbarui varian yang sudah ada; hilangkan untuk menyisipkan varian baru. Juga tersedia di /schemas/{schema_name}. Konten akan divalidasi terhadap skema komponen tersebut.
Auth: Kunci API — selalu diperlukan, dan kunci tersebut harus memiliki izin content_write.
| Param | Tipe | Wajib | Catatan |
|---|---|---|---|
schema_name | string | ya | Nama komponen kustom. |
| Param | Tipe | Wajib | Catatan |
|---|---|---|---|
websiteId | uuid | tidak | Situs web target; akan menggunakan header Host / konfigurasi jika tidak disediakan. |
api_key | string | tidak | Alternatif untuk header x-api-key. |
{
"id": "<uuid>",
"title": "Varian saya",
"content": { "title": "Halo", "body": "..." }
}
| Bidang | Tipe | Wajib | Catatan |
|---|---|---|---|
id | uuid | tidak | Perbarui varian yang cocok ketika ada; sisipkan ketika tidak ada atau tidak ditemukan. |
title | string | tidak | Judul tampilan. Secara bawaan menjadi "Tanpa judul" saat penyisipan; dibiarkan tidak berubah saat pembaruan bila dihilangkan. |
content | object | ya | Nilai bidang, divalidasi terhadap skema komponen. Harus berupa objek JSON. |
{
"id": "...",
"schema_name": "pos",
"title": "Varian saya",
"status": "draf",
"version": 2,
"created": true
}
created bernilai true saat penyisipan (HTTP 201) dan false saat pembaruan (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":"Halo"}}'
400 — websiteId tidak valid, content bukan objek, komponen tidak dikenal atau diarsipkan, atau kegagalan validasi401 — kunci API hilang atau tidak valid403 — kunci tidak memiliki izin content_write404 — id diberikan tetapi tidak ada varian yang cocok