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

क्रॉल जॉब बनाएं

दिए गए URL को तय गहराई और पेज सीमाओं के साथ क्रॉल करने के लिए क्रॉल जॉब बनाएं।

हेडर

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

अनुरोध

This endpoint expects an object.
urlstringआवश्यक

डॉक्यूमेंटेशन के उस पेज का URL, जिसे एजेंट यूज़र्स के साथ इंटरैक्ट करने के लिए एक्सेस कर सकेगा।

max_pagesintegerवैकल्पिक1-10000डिफ़ॉल्ट: 1000

क्रॉल किए जाने वाले पेजों की अधिकतम संख्या (1-10,000), डिफ़ॉल्ट 1000 है।

patternstring or nullवैकल्पिक<=2048 characters

सेट होने पर, केवल इस पैटर्न से मेल खाने वाले URLs शामिल किए जाते हैं।

sitemap_urlslist of strings or nullवैकल्पिक

साइटमैप से क्रॉल किए जाने वाले URL की सूची (वैकल्पिक, ऑटोमैटिक URL डिस्कवरी को ओवरराइड करती है)।

parent_folder_idstring or nullवैकल्पिक

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

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

क्या इस URL दस्तावेज़ के लिए auto-sync सक्षम करना है।

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

क्या URL अनुपलब्ध होने पर दस्तावेज़ को अपने-आप हटाना है। यह केवल auto-sync सक्षम होने पर लागू है।

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

ऑटो-सिंक के दौरान पहले से क्रॉल किए गए पेजों से लिंक किए गए नए पेज अपने-आप खोजें और जोड़ें। इसके लिए enable_auto_sync=true आवश्यक है।

minimum_frequency_daysinteger or nullवैकल्पिक1-180

न्यूनतम आवृत्ति (दिनों में) जिस पर अंतर्निहित पात्र दस्तावेज़ रीफ़्रेश होते हैं। वास्तविक अंतराल कम हो सकता है, कभी ज़्यादा नहीं। डिफ़ॉल्ट 7 है; पैरेंट फ़ोल्डर की आवृत्ति अधिक सख्त होने पर उसी के अनुसार सेट किया जाता है। केवल ऑटो-सिंक सक्षम होने पर लागू।

max_depthintegerवैकल्पिकडिफ़ॉल्ट: 3Deprecated

डीप्रिकेटेड - यह फ़ील्ड कोई काम नहीं करता और भविष्य के वर्ज़न में हटा दिया जाएगा।

रिस्पॉन्स

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

idstring
typeenumडिफ़ॉल्ट: discovery
अनुमत मान:
root_folder_idstring
statusstring
created_atinteger
folder_pathlist of objectsवैकल्पिक

रूट से पैरेंट फ़ोल्डर तक, रूट फ़ोल्डर तक ले जाने वाले फ़ोल्डर पाथ सेगमेंट।

त्रुटियाँ

422
Unprocessable Entity Error