profound-logoProfound CMS
⌘K
Admin
Theme
DocsTutorialBlogPhilosophy
DocsTutorialBlogPhilosophy

Hybrid

Collection of Pages with ComponentsTypes of ComponentsSetup server sent events (SSE) content refetchInstall Profound CMS as a proxyCEL Scripting in Template BuilderProject ScaffoldingMedia Library

Tanpa kepala

Mulai CepatSplit Screen JSON Component Builder with LLMPenarikan Komponen Zod

REST API

ikhtisar API RESTgetConnect your websitegetGET /routesgetGET /routegetGET /blocksgetGET /blocks/with-cel-cachegetGET /blocks/generatedgetGET /componentsgetGET /components/{name}getGET /dataset/{schema_name}getGET /content-changes (SSE)patchPATCH /dataset/{schema_name}postPOST /translationpatchPATCH /translationsgetGET /usagepostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

PATCH /dataset/{schema_name}

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.

Parameter path

ParamTipeWajibCatatan
schema_namestringyaNama komponen kustom.

Parameter query

ParamTipeWajibCatatan
websiteIduuidtidakSitus web target; akan menggunakan header Host / konfigurasi jika tidak disediakan.
api_keystringtidakAlternatif untuk header x-api-key.

Body permintaan

{
  "id": "<uuid>",
  "title": "Varian saya",
  "content": { "title": "Halo", "body": "..." }
}
BidangTipeWajibCatatan
iduuidtidakPerbarui varian yang cocok ketika ada; sisipkan ketika tidak ada atau tidak ditemukan.
titlestringtidakJudul tampilan. Secara bawaan menjadi "Tanpa judul" saat penyisipan; dibiarkan tidak berubah saat pembaruan bila dihilangkan.
contentobjectyaNilai bidang, divalidasi terhadap skema komponen. Harus berupa objek JSON.

Respons

{
  "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).

Contoh

curl -X PATCH '{CMS_API_URL}/dataset/post?websiteId=<uuid>' \
  -H 'x-api-key: <key>' \
  -H 'Content-Type: application/json' \
  -d '{"content":{"title":"Halo"}}'

Kesalahan

  • 400 — websiteId tidak valid, content bukan objek, komponen tidak dikenal atau diarsipkan, atau kegagalan validasi
  • 401 — kunci API hilang atau tidak valid
  • 403 — kunci tidak memiliki izin content_write
  • 404 — id diberikan tetapi tidak ada varian yang cocok
Continue Reading
Previous‹GET /content-changes (SSE)NextPOST /translation›