नेविगेशन पर जाएँ

नॉलेज बेस सूची पाएं

उपलब्ध नॉलेज बेस दस्तावेज़ों की सूची प्राप्त करें

हेडर

xi-api-keystringवैकल्पिक

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

page_sizeintegerवैकल्पिक1-100डिफ़ॉल्ट: 30

ज़्यादा से ज़्यादा कितने दस्तावेज़ लौटाने हैं। 100 से ज़्यादा नहीं हो सकते, डिफ़ॉल्ट 30 है।

searchstringवैकल्पिक

निर्दिष्ट होने पर, endpoint केवल वे नॉलेज बेस दस्तावेज़ लौटाता है जिनके नाम इस स्ट्रिंग से शुरू होते हैं।

show_only_owned_documentsbooleanवैकल्पिकडिफ़ॉल्ट: falseDeprecated

true पर सेट होने पर, endpoint केवल आपके स्वामित्व वाले दस्तावेज़ लौटाएगा (किसी और द्वारा शेयर किए गए नहीं)। अप्रचलित: इसके बजाय created_by_user_id इस्तेमाल करें।

created_by_user_idstringवैकल्पिक

क्रिएटर यूज़र ID के अनुसार दस्तावेज़ फ़िल्टर करें। सेट होने पर सिर्फ़ इस यूज़र के बनाए दस्तावेज़ लौटाए जाते हैं। यह show_only_owned_documents पर प्राथमिकता रखता है। प्रमाणित यूज़र के लिए ‘@me’ इस्तेमाल करें।

typesenumवैकल्पिक

मौजूद होने पर, endpoint केवल दिए गए प्रकारों के दस्तावेज़ लौटाएगा।

अनुमत मान:
parent_folder_idstringवैकल्पिक

सेट होने पर, endpoint केवल दिए गए फ़ोल्डर के सीधे अंदर मौजूद दस्तावेज़ लौटाएगा।

ancestor_folder_idstringवैकल्पिक

सेट होने पर, endpoint केवल दिए गए फ़ोल्डर के अंतर्गत आने वाले दस्तावेज़ लौटाएगा।

folders_firstbooleanवैकल्पिकडिफ़ॉल्ट: false

क्या दस्तावेज़ों की सूची में folders पहले लौटाए जाने चाहिए।

sort_directionenumवैकल्पिक

नतीजों को सॉर्ट करने की दिशा

अनुमत मान:
sort_byenumवैकल्पिक

नतीजों को सॉर्ट करने के लिए फ़ील्ड

अनुमत मान:
cursorstringवैकल्पिक

अगला पेज फ़ेच करने के लिए इस्तेमाल होता है। रिस्पॉन्स में cursor लौटाया जाता है।

रिस्पॉन्स

सफल रिस्पॉन्स

documentslist of objects
has_moreboolean
next_cursorstringवैकल्पिक

त्रुटियाँ

422
Knowledge Base List Request Unprocessable Entity Error