कस्टम घटक के दस्तावेज़ वेरिएंट को दस्तावेज़ आईडी के आधार पर अपसर्ट करें।
कस्टम घटक का एक वेरिएंट (एक documents पंक्ति) अपसर्ट करें, जो दस्तावेज़ id पर आधारित है। मौजूदा वेरिएंट को अपडेट करने के लिए id प्रदान करें; नया वेरिएंट जोड़ने के लिए इसे छोड़ दें। यह /schemas/{schema_name} पर भी उपलब्ध है। सामग्री को घटक की स्कीमा के अनुसार सत्यापित किया जाता है।
प्रमाणीकरण: API key — हमेशा आवश्यक, और कुंजी में content_write अनुमति होना अनिवार्य है।
| पैराम | प्रकार | अनिवार्य | टिप्पणियाँ |
|---|---|---|---|
schema_name | string | हाँ | कस्टम घटक का नाम। |
| पैराम | प्रकार | अनिवार्य | टिप्पणियाँ |
|---|---|---|---|
websiteId | uuid | नहीं | लक्षित वेबसाइट; Host हेडर / कॉन्फ़िग पर वापस चली जाती है। |
api_key | string | नहीं | x-api-key हेडर का विकल्प। |
{
"id": "<uuid>",
"title": "मेरा वेरिएंट",
"content": { "title": "नमस्ते", "body": "..." }
}
| फ़ील्ड | प्रकार | अनिवार्य | टिप्पणियाँ |
|---|---|---|---|
id | uuid | नहीं | उपस्थित होने पर मेल खाने वाले वेरिएंट को अपडेट करें; अनुपस्थित या न मिलने पर जोड़ें। |
title | string | नहीं | प्रदर्शन शीर्षक। इन्सर्ट पर डिफ़ॉल्ट "Untitled"; अपडेट के समय छोड़े जाने पर अपरिवर्तित रहता है। |
content | object | हाँ | फ़ील्ड मान, घटक की स्कीमा के अनुसार सत्यापित किए जाते हैं। एक JSON ऑब्जेक्ट होना चाहिए। |
{
"id": "...",
"schema_name": "post",
"title": "मेरा वेरिएंट",
"status": "draft",
"version": 2,
"created": true
}
created इन्सर्ट (HTTP 201) पर true और अपडेट (HTTP 200) पर false होता है।
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 प्रदान किया गया लेकिन कोई मेल खाता वेरिएंट नहीं