GET /components/{name}

नाम के आधार पर एक कस्टम कॉम्पोनेंट की सभी फ़ील्ड की परिभाषा प्राप्त करें।

नाम के आधार पर किसी एक कस्टम कॉम्पोनेंट की पूर्ण परिभाषा, उसकी फ़ील्ड सूची सहित, प्राप्त करें।

प्रमाणीकरण: API कुंजी (x-api-key हेडर या api_key क्वेरी पैरामीटर)।

पाथ पैरामीटर

पैरामीटर	प्रकार	आवश्यक	नोट्स
`name`	string	हाँ	स्कीमा का नाम, उदाहरण के लिए `post`.

क्वेरी पैरामीटर

पैरामीटर	प्रकार	आवश्यक	नोट्स
`websiteId`	uuid	हाँ	एक मान्य UUID होना चाहिए।
`api_key`	string	नहीं	`x-api-key` हेडर का विकल्प।

प्रत्युत्तर

{
  "id": "...",
  "name": "post",
  "displayName": "Post",
  "description": "A documentation Post",
  "category": "Custom",
  "titleField": "title",
  "routeSlugField": "title",
  "icon": null,
  "fields": [
    { "name": "title", "type": "string", "required": true }
  ],
  "slugFields": ["title", "description"],
  "version": 8
}

slugFields स्वतः गणना किया जाता है — सभी स्ट्रिंग-प्रकार के फ़ील्ड के नाम।

उदाहरण

curl '{CMS_API_URL}/components/post?websiteId=<uuid>' \
  -H 'x-api-key: <key>'

त्रुटियाँ

400 — websiteId अनुपस्थित या अमान्य
401 — अमान्य API कुंजी
404 — स्कीमा नहीं मिला

Previous‹घटक प्राप्त करें Nextडेटासेट स्कीमा नाम प्राप्त करें›

पैरामीटर

प्रकार

आवश्यक

नोट्स

name

string

हाँ

स्कीमा का नाम, उदाहरण के लिए post.

पैरामीटर

प्रकार

आवश्यक

नोट्स

websiteId

uuid

हाँ

एक मान्य UUID होना चाहिए।

api_key

string

नहीं

x-api-key हेडर का विकल्प।

प्रत्युत्तर

{
  "id": "...",
  "name": "post",
  "displayName": "Post",
  "description": "A documentation Post",
  "category": "Custom",
  "titleField": "title",
  "routeSlugField": "title",
  "icon": null,
  "fields": [
    { "name": "title", "type": "string", "required": true }
  ],
  "slugFields": ["title", "description"],
  "version": 8
}

slugFields स्वतः गणना किया जाता है — सभी स्ट्रिंग-प्रकार के फ़ील्ड के नाम।