Content Type

CDA(Content Delivery API) एक रीड-ओनली API है जो प्रकाशित संसाधनों को सार्वजनिक विज़िटर तक पहुँचाता है। यह पेज बताता है कि प्रकाशित Content Type, यानी वह ढाँचा (स्कीमा) जिसका Content पालन करता है, उसे कैसे पढ़ा जाए। इस ढाँचे में कौन-कौन से फ़ील्ड हैं और हर फ़ील्ड का प्रकार, बहुभाषी होना या न होना, अनिवार्य होना या न होना, और वैधता नियम क्या हैं, यह CDA से पढ़ लेने पर आप उस ढाँचे का पालन करने वाले प्रकाशित Content का स्वरूप पहले से जान सकते हैं।

CDA में केवल पठन (GET) एंडपॉइंट हैं; Content Type को बनाना, बदलना और प्रकाशित करना CMA Content Type संभालता है। प्रमाणीकरण और प्रकाशन डिलीवरी मॉडल (प्रकाशन स्नैपशॉट, revision, केवल प्रकाशित संसाधन दिखना) जैसे CDA के सामान्य व्यवहार के लिए CDA अवलोकन देखें। Content Type ढाँचे का स्कीमा है, इसलिए इसके पठन में locale पैरामीटर स्वीकार नहीं किया जाता।

संसाधन संरचना

नीचे डेमो Space के प्रकाशित Content Type "उत्पाद" को CDA एकल पठन में जिस रूप में पहुँचाता है, वह दिखाया गया है। इसमें sys (सिस्टम गुण) के साथ-साथ name, displayField, publishWithAuthor, fields जैसे मुख्य गुण होते हैं।

{
  "sys": {
    "id": "3trmXRLdJF4GBlAjtcuoZ7Pnxj8dlA",
    "type": "ContentType",
    "space": { "sys": { "id": "HnQ32YiH", "type": "Refer", "targetType": "Space" } },
    "createdAt": "2026-06-14T17:04:46.846Z",
    "updatedAt": "2026-06-17T03:13:49.943Z",
    "revision": 7
  },
  "name": "उत्पाद",
  "displayField": "productName",
  "fields": [
    { "id": "5n06s7ocmwdi", "name": "उत्पाद नाम", "apiName": "productName", "type": "ShortText", "localized": true, "required": true, "validations": [], "disabled": false },
    { "id": "1gecyz8g4llwf", "name": "मूल्य", "apiName": "price", "type": "Long", "localized": false, "required": false, "validations": [], "disabled": false },
    { "id": "3ow4popgz54zg", "name": "विवरण", "apiName": "description", "type": "RichText", "localized": true, "required": false, "validations": [], "disabled": false },
    { "id": "2alxdptmdub1s", "name": "फ़ोटो", "apiName": "photo", "type": "Refer", "localized": false, "required": false, "validations": [], "disabled": false, "targetType": "Media" },
    {
      "id": "2a80lehazfx3t",
      "name": "ब्रांड",
      "apiName": "brand",
      "type": "Refer",
      "localized": false,
      "required": false,
      "validations": [
        { "referContentType": [ { "sys": { "id": "3trmXRM3RqbgSnifyg7OveRYWnJWEG", "type": "Refer", "targetType": "ContentType" } } ] }
      ],
      "disabled": false,
      "targetType": "Content"
    }
  ],
  "publishWithAuthor": false
}

मुख्य कीज़:

  • sys.id: Content Type का विशिष्ट पहचानकर्ता। एकल पठन पथ के {contentTypeId} में यही जाता है।
  • sys.revision: सार्वजनिक किए जाने के समय का संस्करण। CDA प्रबंधन-संबंधी version शामिल नहीं करता, इसलिए प्रकाशन संस्करण को इंगित करने वाला मान केवल revision है।
  • name: Content Type का नाम (उदाहरण: उत्पाद)।
  • displayField: कंटेंट स्टूडियो सूची में प्रत्येक Content का प्रतिनिधित्व करने के लिए दिखाए जाने वाले फ़ील्ड का apiName (उदाहरण: productName)।
  • publishWithAuthor: Content प्रकाशित करते समय लेखक की जानकारी साथ शामिल करनी है या नहीं (उदाहरण में false)।
  • fields: इस ढाँचे द्वारा परिभाषित फ़ील्ड की सूची। प्रत्येक आइटम की संरचना नीचे फ़ील्ड में बताई गई है।

सिस्टम गुण (sys)

प्रकाशित Content Type का sys केवल प्रकाशन स्नैपशॉट के गुण रखता है। space, createdBy, updatedBy Refer स्वरूप ({ "sys": { "id", "type": "Refer", "targetType" } }) में आते हैं।

गुणप्रकारविवरण
idstringसंसाधन का विशिष्ट पहचानकर्ता।
typestringसंसाधन का प्रकार। Content Type के लिए हमेशा "ContentType"
spaceRefer<Space>वह Space जिससे यह Content Type संबंधित है।
createdAtstring (date-time)निर्माण का समय।
updatedAtstring (date-time)अंतिम संशोधन का समय।
revisionintegerसार्वजनिक किए जाने के समय का संस्करण। हर प्रकाशन पर उस समय का संस्करण यहाँ दर्ज होता है।
createdByRefer<User>बनाने वाला उपयोगकर्ता। यह तभी शामिल होता है जब Content Type का publishWithAuthor चालू हो।
updatedByRefer<User>अंतिम संशोधन करने वाला उपयोगकर्ता। यह तभी शामिल होता है जब publishWithAuthor चालू हो।

चूँकि यह प्रकाशन स्नैपशॉट है, CMA के sys में मौजूद version, status, publish, archive यहाँ शामिल नहीं होते। प्रकाशन संस्करण को इंगित करने वाला मान केवल revision है।

फ़ील्ड

fields इस Content Type द्वारा परिभाषित फ़ील्ड की सूची है। प्रत्येक आइटम की निम्नलिखित संरचना (FieldDefinition) होती है।

कीप्रकारविवरण
idstringफ़ील्ड का विशिष्ट पहचानकर्ता।
namestringकंटेंट स्टूडियो में दिखने वाला फ़ील्ड का नाम (उदाहरण: उत्पाद नाम)।
apiNamestringAPI में इस फ़ील्ड को इंगित करने वाली की। प्रकाशित Content के fields में भी मान इसी की से पढ़ा जाता है।
typestring (enum)फ़ील्ड का प्रकार। नीचे फ़ील्ड प्रकार (type) देखें।
localizedbooleanबहुभाषी मान रख सकता है या नहीं।
requiredbooleanअनिवार्य इनपुट है या नहीं।
validationsarrayमान पर लागू वैधता नियमों की सूची। कोई नियम न हो तो खाली सरणी []
disabledbooleanनिष्क्रिय है या नहीं।
targetTypestring (enum)केवल तब जब type Refer हो। संदर्भ का लक्ष्य Content है या Media
itemsobjectकेवल तब जब type Array हो। सरणी के तत्व की परिभाषा (Refer तत्व या ShortText तत्व)।

फ़ील्ड प्रकार (type)

type यह निर्धारित करता है कि मान किस तरह संग्रहित और पठित होता है। कुछ प्रकारों का खोज व्यवहार अलग होता है।

typeअर्थटिप्पणी
ShortTextछोटा एकल-पंक्ति टेक्स्ट।सटीक कीवर्ड खोज के लिए उपयुक्त।
LongTextलंबा मुख्य टेक्स्ट।पूर्ण-पाठ (full-text) समानता खोज का समर्थन करता है।
RichTextस्वरूपण वाला मुख्य टेक्स्ट।खोज का लक्ष्य नहीं; स्वरूपण प्रस्तुति के लिए।
Longपूर्णांक।उदाहरण: मूल्य price
Numberवास्तविक संख्या (दशमलव सहित)।
Booleanसही/गलत।
Dateदिनांक और समय।
Jsonमनमानी JSON संरचना।
Locationस्थान (निर्देशांक)।
Referकिसी अन्य संसाधन की ओर संदर्भ।targetType से Content या Media निर्दिष्ट करें।
Arrayकई मान रखने वाली सरणी।items के साथ तत्व परिभाषा शामिल।

"उत्पाद" उदाहरण में उत्पाद नाम ShortText है, मूल्य Long है, विवरण RichText है, फ़ोटो Refer (targetType: Media) है, और ब्रांड Refer (targetType: Content) है। ब्रांड फ़ील्ड validations के referContentType से केवल किसी विशिष्ट Content Type (यहाँ "ब्रांड", जिसका sys.id 3trmXRM3RqbgSnifyg7OveRYWnJWEG है) के Content को संदर्भित करने तक सीमित करता है।

validations में उपयोग किए जा सकने वाले वैधता नियमों की पूरी की सूची CMA Content Type में संकलित है। CDA जो प्रकाशन स्नैपशॉट पहुँचाता है, वह भी वही संरचना ज्यों की त्यों रखता है।

API

नीचे दिए दोनों एंडपॉइंट का आधार URL https://cda.weegloo.com/v1 है, और Authorization हेडर में CDA को प्रमाणित करने वाला Bearer टोकन आवश्यक है। Content Type एक ढाँचा (स्कीमा) है, इसलिए वह भाषा चुनने का विषय नहीं है; इस कारण Content पठन के विपरीत यह locale क्वेरी पैरामीटर स्वीकार नहीं करता।

  • CMA Content Type: Content Type बनाने और संशोधित करने वाला प्रबंधन API (फ़ील्ड प्रकार और वैधता जाँच की पूरी विशिष्टि सहित)।
  • CDA Content: इस ढाँचे का पालन करने वाला प्रकाशित Content प्राप्त करना।
  • स्थिति और प्रकाशन (अवधारणा): प्रकाशन और संस्करण का अर्थ।