profound-logoProfound CMS
⌘K
Admin
Theme
BelgelerTutorialBlogPhilosophy
BelgelerTutorialBlogPhilosophy

Hybrid

Collection of Pages with ComponentsTypes of ComponentsSetup server sent events (SSE) content refetchInstall Profound CMS as a proxyŞablon oluşturucuda komut dosyası yazmaProject ScaffoldingMedia Library

Headless

Hızlı BaşlangıçSplit Screen JSON Component Builder with LLMComponent Zod Pull

REST API

REST API OverviewgetConnect your websitegetGET /routesgetGET /routegetGET /blocksgetCEL önbelleği ile blokları getirgetGET /blocks/generatedgetGET /componentsgetGET /components/{name}getVeri kümesi şema adını algetGET /content-changes (SSE)patchPATCH /dataset/{schema_name}postGönderi çevirisipatchÇeviri yamalarıgetKullanımı alpostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

PATCH /dataset/{schema_name}

Belge kimliğine göre anahtarlanmış özel bir bileşenin belge varyantını ekleyin ya da güncelleyin.

Belgelerin id değerine göre anahtarlanmış özel bir bileşenin varyantını (documents satırı) ekleyin ya da güncelleyin. Mevcut bir varyantı güncellemek için id sağlayın; yeni bir tane eklemek için onu atlayın. /schemas/{schema_name} adresinde de mevcuttur. İçerik, bileşenin şemasına göre doğrulanır.

Kimlik Doğrulama: API anahtarı — her zaman zorunlu ve anahtarın content_write izni olmalıdır.

Yol parametreleri

ParametreTürZorunluNotlar
schema_namestringevetÖzel bileşenin adı.

Sorgu parametreleri

ParametreTürZorunluNotlar
websiteIduuidhayırHedef web sitesi; Host üstbilgisine/yapılandırmasına geri döner.
api_keystringhayırx-api-key üstbilgisine alternatif.

İstek gövdesi

{
  "id": "<uuid>",
  "title": "My variant",
  "content": { "title": "Hello", "body": "..." }
}
AlanTürZorunluNotlar
iduuidhayırMevcutsa eşleşen varyantı günceller; yoksa veya bulunamazsa ekler.
titlestringhayırGörünen başlık. Eklemede varsayılan "Untitled"; güncellemede atlandığında değiştirilmez.
contentobjectevetAlan değerleri, bileşenin şemasına göre doğrulanır. Bir JSON nesnesi olmalıdır.

Yanıt

{
  "id": "...",
  "schema_name": "post",
  "title": "My variant",
  "status": "draft",
  "version": 2,
  "created": true
}

created, eklemede (HTTP 201) true, güncellemede (HTTP 200) false olur.

Örnek

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

Hatalar

  • 400 — geçersiz websiteId, nesne olmayan content, bilinmeyen ya da arşivlenmiş bileşen veya doğrulama hatası
  • 401 — eksik veya geçersiz API anahtarı
  • 403 — anahtarın content_write izni yok
  • 404 — id sağlandı fakat eşleşen varyant yok
Continue Reading
Previous‹GET /content-changes (SSE)NextGönderi çevirisi›