किसी स्कीमा के प्रकाशित दस्तावेज़ — सभी, एक, बैच, या एक पृष्ठ — को स्ट्रीम किए गए JSON array के रूप में प्राप्त करें।
किसी स्कीमा के प्रकाशित दस्तावेज़ प्राप्त करें — सभी, एकल दस्तावेज़, आईडी के आधार पर बैच, या एक पृष्ठ — जिन्हें JSON array के रूप में स्ट्रीम किया जाता है। /schemas/{schema_name} पर भी उपलब्ध। इमेज संदर्भों को URL में हल किया जाता है, और जब language सेट होता है तो मिलती-जुलती अनुवादित सामग्री मूल सामग्री पर मिला दी जाती है।
प्रमाणीकरण: API कुंजी। सर्वर जब require_schema_api_key = true सेट करता है तभी कुंजी की आवश्यकता होती है; अन्यथा गुमनाम पढ़ना अनुमत है।
| पैरामीटर | प्रकार | आवश्यक | टिप्पणियाँ |
|---|---|---|---|
schema_name | string | हाँ | दस्तावेज़ स्कीमा, उदाहरण के लिए post. |
| पैरामीटर | प्रकार | आवश्यक | टिप्पणियाँ |
|---|---|---|---|
websiteId | uuid | नहीं | लक्षित वेबसाइट; Host हेडर / कॉन्फ़िग पर वापस लौटती है. |
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 array। प्रत्येक तत्व में दस्तावेज़ की प्रकाशित सामग्री शीर्ष स्तर पर विस्तारित होती है, और साथ में _id, _title, और _publishedAt कुंजियाँ जोड़ी जाती हैं:
[
{
"_id": "...",
"_title": "शुरुआत करना",
"_publishedAt": "2026-06-23T20:36:31Z",
"title": "शुरुआत करना",
"description": "...",
"content": "..."
}
]
टकराव की स्थिति में कंटेंट फ़ील्ड्स इंजेक्ट की गई कुंजियों पर प्राथमिकता पाते हैं। { alt, _asset: { id } } के रूप वाली इमेज संदर्भों में _asset के भीतर एक हल किया हुआ url जोड़ दिया जाता है।
curl '{CMS_API_URL}/dataset/post?websiteId=<uuid>&limit=50' \
-H 'x-api-key: <key>'
400 — अमान्य websiteId, अमान्य id, या त्रुटिपूर्ण ids (खाली, 200 से अधिक, या अमान्य UUID)401 — अमान्य API कुंजी (या आवश्यकता होने पर अनुपस्थित)500 — क्वेरी विफलता