किसी वेबसाइट के कस्टम कंपोनेंट (कंटेंट-टाइप स्कीमा) सारांशों की सूची।
किसी वेबसाइट के कस्टम-कंपोनेंट (कंटेंट-टाइप स्कीमा) सारांशों को नाम के अनुसार क्रमबद्ध रूप में सूचीबद्ध करें। केवल उपयोगकर्ता-परिभाषित कस्टम स्कीमा लौटाए जाते हैं।
प्रमाणीकरण: API कुंजी (x-api-key हेडर या api_key क्वेरी पैराम)।
| पैराम | प्रकार | आवश्यक | टिप्पणियाँ |
|---|---|---|---|
websiteId | uuid | हाँ | एक वैध UUID होना चाहिए। इस एंडपॉइंट पर Host/कॉन्फ़िग फॉलबैक नहीं है। |
state | string | नहीं | लाइफ़-साइकल स्थिति के आधार पर फ़िल्टर करें: draft, active या archived। |
api_key | string | नहीं | x-api-key हेडर का विकल्प। |
कंपोनेंट सारांशों का एक JSON ऐरे:
[
{
"id": "...",
"name": "post",
"displayName": "पोस्ट",
"description": "एक दस्तावेज़ीकरण पोस्ट",
"category": "कस्टम",
"tags": [],
"fields": [],
"icon": null,
"source": "custom",
"version": 8,
"routeSlugField": "title"
}
]
source हमेशा "custom" होता है। displayName सेट न होने पर name पर वापस चला जाता है, और category सेट न होने पर डिफ़ॉल्ट रूप से "Custom" होता है।
curl '{CMS_API_URL}/components?websiteId=<uuid>&state=active' \
-H 'x-api-key: <key>'
400 — websiteId गुम या अमान्य401 — अमान्य API कुंजी