ดึงเอกสารที่เผยแพร่สำหรับสคีมา—ทั้งหมด เอกสารเดียว ชุด หรือทีละหน้า—ในรูปแบบอาร์เรย์ JSON แบบสตรีม.
ดึงเอกสารที่เผยแพร่สำหรับสคีมา—ทั้งหมด เอกสารเดียว ชุดตาม ID หรือทีละหน้า—ในรูปแบบสตรีมเป็นอาร์เรย์ JSON พร้อมใช้งานที่ /schemas/{schema_name} ด้วย การอ้างอิงรูปภาพจะถูกแปลงเป็น URL และเมื่อกำหนด language การแปลที่ตรงกันจะถูกผสานทับบนเนื้อหาพื้นฐาน.
การยืนยันตัวตน: คีย์ API ต้องใช้คีย์ก็ต่อเมื่อเซิร์ฟเวอร์ตั้งค่า require_schema_api_key = true; มิฉะนั้นการอ่านแบบไม่ระบุตัวตนจะได้รับอนุญาต.
| พารามิเตอร์ | ชนิด | ต้องระบุ | หมายเหตุ |
|---|---|---|---|
schema_name | string | ใช่ | สคีมาของเอกสาร เช่น post. |
| พารามิเตอร์ | ชนิด | ต้องระบุ | หมายเหตุ |
|---|---|---|---|
websiteId | uuid | ไม่ | เว็บไซต์เป้าหมาย; หากไม่ระบุจะใช้ค่า Host header / config. |
id | uuid | ไม่ | ดึงเอกสารเพียงรายการเดียว มีลำดับความสำคัญเหนือ ids. |
ids | string | ไม่ | UUID ที่คั่นด้วยเครื่องหมายจุลภาค (เป็นชุด สูงสุด 200) มีลำดับความสำคัญเหนือการแบ่งหน้า. |
language | string | ไม่ | ผสานการแปลสำหรับภาษานี้ทับบนเนื้อหาพื้นฐาน. |
limit | integer | ไม่ | ขนาดหน้า ค่าเริ่มต้น 200 จำกัดสูงสุด 200. |
offset | integer | ไม่ | จำนวนแถวที่จะข้าม (ใช้ได้เมื่อ limit เป็นค่าบวกเท่านั้น). |
api_key | string | ไม่ | ทางเลือกแทนเฮดเดอร์ x-api-key. |
เมื่อไม่ได้กำหนดทั้ง id และ ids เอกสารจะถูกส่งกลับโดยเรียงตาม published_at DESC.
เป็นอาร์เรย์ JSON แบบสตรีม แต่ละองค์ประกอบคือเนื้อหาที่เผยแพร่ของเอกสารถูกกระจายบนระดับบนสุด และมีคีย์ _id, _title, และ _publishedAt ที่ถูกแทรกเพิ่ม:
[
{
"_id": "...",
"_title": "เริ่มต้นใช้งาน",
"_publishedAt": "2026-06-23T20:36:31Z",
"title": "เริ่มต้นใช้งาน",
"description": "...",
"content": "..."
}
]
ฟิลด์เนื้อหาจะมีความสำคัญเหนือคีย์ที่ถูกแทรกเมื่อมีการชนกัน การอ้างอิงรูปภาพในรูปแบบ { alt, _asset: { id } } จะได้รับ url ที่ถูกแปลงแล้วแทรกไว้ใน _asset.
curl '{CMS_API_URL}/dataset/post?websiteId=<uuid>&limit=50' \
-H 'x-api-key: <key>'
400 — websiteId ไม่ถูกต้อง, id ไม่ถูกต้อง หรือ ids ไม่ถูกต้อง (ว่าง มากกว่า 200 หรือเป็น UUID ที่ไม่ถูกต้อง)401 — คีย์ API ไม่ถูกต้อง (หรือไม่มีเมื่อจำเป็น)500 — การสืบค้นล้มเหลว