اجلب المستندات المنشورة لمخطط معيّن — جميعها، أو واحدًا، أو دفعة، أو صفحة — كمصفوفة JSON متدفقة.
اجلب المستندات المنشورة لمخطط معيّن — جميعها، أو مستندًا واحدًا، أو دفعة بحسب المعرفات، أو صفحة — يتم بثها كمصفوفة JSON. متاح أيضًا عند /schemas/{schema_name}. يتم تحويل مراجع الصور إلى روابط URL، وعند تعيين language يتم دمج الترجمة المطابقة فوق المحتوى الأساسي.
المصادقة: مفتاح واجهة برمجة التطبيقات. يُطلب المفتاح فقط عندما يضبط الخادم require_schema_api_key = true؛ وإلا يُسمح بالقراءة دون هوية.
| المعامل | النوع | مطلوب | ملاحظات |
|---|---|---|---|
schema_name | سلسلة | نعم | مخطط المستند، مثلًا post. |
| المعامل | النوع | مطلوب | ملاحظات |
|---|---|---|---|
websiteId | uuid | لا | الموقع المستهدف؛ يعود إلى ترويسة Host / الإعداد عند عدم التحديد. |
id | uuid | لا | يجلب مستندًا واحدًا. يتفوّق على ids. |
ids | سلسلة | لا | معرّفات UUID مفصولة بفواصل (دفعة، الحد الأقصى 200). يتفوّق على ترقيم الصفحات. |
language | سلسلة | لا | يدمج الترجمة لهذه اللغة فوق المحتوى الأساسي. |
limit | عدد صحيح | لا | حجم الصفحة، القيمة الافتراضية 200، والحد الأقصى 200. |
offset | عدد صحيح | لا | عدد الصفوف التي سيتم تخطيها (لا يُطبَّق إلا عند وجود حدّ موجب). |
api_key | سلسلة | لا | بديل عن ترويسة 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 — مفتاح واجهة برمجة التطبيقات غير صالح (أو مفقود عند الحاجة)500 — فشل في الاستعلام