واجهة برمجة التطبيقات:قوائم

From mediawiki.org
This page is a translated version of the page API:Lists and the translation is 100% complete.

طلب GET يسرد قائمة بالبنود التي تنطبق عليها المعايير المختارة.

توثيق واجهة برمجة التطبيقات

ترد القوائم بوجه عام بيانات مجمعة، مثل صفحات مجمعة من كافة أرجاء موقع ويكي أو وصلات شبكية مجمعة من صفحة واحدة. كي تطلب قائمة، مرر إلى المتغير list من سطر استعلامك وحدة برمجية فرعية لقائمة سارية، مثل allimages أو usercontribs.

كي تستخدم واجهة برمجة تطبيقات القوائم، حدد action=query&list=list1|list2 في معرف الموارد الموحد.

طالع صفحات واجهة برمجة تطبيقات القوائم المنفردة لمزيد من الأمثلة المفيدة عن كيفية استخدام القوائم:

ملاحظات إضافية

  • أغلب الوحدات البرمجية الفرعية للقوائم يمكن استخدامها مولّدات ، إلا لو كان خلاف ذلك مذكورًا.
  • تختلف القوائم عن properties من ناحية أنها بدلا من إلحاقها البيانات بالعناصر الموجودة في عنصر pages، يخصص لكل قائمة فرعها الخاص المستقل في عنصر query.
  • سرد قائمة بحدود الاستعلام:
    • يمكن تحديد الحد الأقصى للنتائج ليكون 500 للمستخدمين العاديين، أو 5000 للمستخدمين الذين يتمتعون بحق apihighlimits (الذي يمنح عادة للبوتات ومشغلي النظام).
    • تفرض بعض الوحدات البرمجية حدود قصوى صارمة بموجب شروط محددة. انظر هذه الصفحة الفرعية لمزيد من التفاصيل.
    • إن لم تكن متأكدًا من الحد الأقصى الساري عليك وترغب في الحصول على أكبر عدد ممكن من النتائج، حدد الحد الأقصى ليكون max. في تلك الحالة، سوف يرد الأمر عنصر limits، محددًا الحد الأقصى المستخدم.
    • يتألف متغير الحد الأقصى لوحدة برمجية محددة من بادئة الوحد البرمجية يتبعها limit، حيث ptlimit هو العدد الأقصى من protectedtitles المردود، وcmlimit هو العدد الأقصى من cmlimit المردود.

انظر أيضا