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

Headless

Quick startJSON และ Claude Codeดึงคำอธิบาย Zod ของคอมโพเนนต์

REST API

REST API Overviewgetเชื่อมต่อเว็บไซต์กับ CMS APIgetGET /routesgetGET /routegetGET /blocksgetรับบล็อกพร้อมแคช CELgetGET /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}

เพิ่มหรืออัปเดตตัวแปรของเอกสารสำหรับคอมโพเนนต์แบบกำหนดเอง โดยใช้รหัสเอกสารเป็นคีย์.

เพิ่มหรืออัปเดต variant (แถวใน documents) ของคอมโพเนนต์แบบกำหนดเอง โดยใช้ id ของเอกสารเป็นคีย์ ระบุ id เพื่ออัปเดตตัวแปรที่มีอยู่แล้ว; ละไว้เพื่อแทรกตัวใหม่ ใช้งานได้ที่ /schemas/{schema_name} ด้วย เนื้อหาจะถูกตรวจสอบความถูกต้องตามสคีมาของคอมโพเนนต์.

การยืนยันตัวตน: คีย์ API — ต้องใช้เสมอ และคีย์ต้องมีสิทธิ์ content_write.

พารามิเตอร์เส้นทาง

พารามิเตอร์ชนิดจำเป็นหมายเหตุ
schema_namestringใช่ชื่อคอมโพเนนต์แบบกำหนดเอง.

พารามิเตอร์คิวรี

พารามิเตอร์ชนิดจำเป็นหมายเหตุ
websiteIduuidไม่เว็บไซต์เป้าหมาย; จะย้อนกลับไปใช้เฮดเดอร์ Host / การตั้งค่าหากไม่ได้ระบุ.
api_keystringไม่ทางเลือกแทนเฮดเดอร์ x-api-key.

เนื้อหาในคำขอ

{
  "id": "<uuid>",
  "title": "ตัวแปรของฉัน",
  "content": { "title": "สวัสดี", "body": "..." }
}
ฟิลด์ชนิดจำเป็นหมายเหตุ
iduuidไม่อัปเดตตัวแปรที่ตรงกันเมื่อมี; แทรกเมื่อไม่มีหรือไม่พบ.
titlestringไม่ชื่อที่แสดง ค่าเริ่มต้นเป็น "Untitled" เมื่อแทรก; จะคงเดิมเมื่ออัปเดตหากละไว้.
contentobjectใช่ค่าของฟิลด์ ตรวจสอบความถูกต้องตามสคีมาของคอมโพเนนต์ ต้องเป็นอ็อบเจ็กต์ JSON.

การตอบกลับ

{
  "id": "...",
  "schema_name": "post",
  "title": "ตัวแปรของฉัน",
  "status": "ฉบับร่าง",
  "version": 2,
  "created": true
}

created จะเป็น true เมื่อแทรก (HTTP 201) และเป็น 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":"สวัสดี"}}'

ข้อผิดพลาด

  • 400 — websiteId ไม่ถูกต้อง, content ที่ไม่ใช่อ็อบเจ็กต์, คอมโพเนนต์ที่ไม่รู้จักหรือถูกเก็บถาวร, หรือการตรวจสอบไม่ผ่าน
  • 401 — ไม่มีหรือคีย์ API ไม่ถูกต้อง
  • 403 — คีย์ไม่มีสิทธิ์ content_write
  • 404 — ระบุ id แต่ไม่พบตัวแปรที่ตรงกัน
Continue Reading
Previous‹GET /content-changes (SSE)NextPOST /translation›