עזרה של MediaWiki API

זהו דף תיעוד של API שנוצר באופן אוטומטי.

תיעוד ודוגמאות: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page

prop=info (in)

  • יחידה זו דורשת הרשאות קריאה.
  • מקור: MediaWiki
  • רישיון: GPL-2.0-or-later

קבלת מידע בסיסי על הדף.

פרמטרים:
inprop

אילו מאפיינים נוספים לקבל:

protection
לרשום את רמת ההגנה של כל דף.
talkid
מזהה הדף של דף השיחה עבור כל דף שאינו דף שיחה.
watched
לרשום את מצב המעקב של כל דף.
watchers
מספר העוקבים, אם קיבלת הרשאה.
visitingwatchers
מספר העוקבים אחרי כל דף שביקרו עריכות אחרונות לאותו הדף, אם זה מותר.
notificationtimestamp
חותם־זמן של הודעת רשימת מעקב של כל דף.
subjectid
מזהה הדף של הדף העיקרי של כל דף שיחה.
url
נותן URL מלא, URL לעריכה ו־URL קנוני לכל דף.
readable
מיושן. האם המשתמש יכול לקרוא את הדף הזה. יש להשתמש ב־intestactions=read במקום זה.
preload
נותן את הטקסט שמוחזר על־ידי EditFormPreloadText.
displaytitle
נותן את האופן שבה שם הדף באמת מוצג.
varianttitles
כותרת התצוגה בכל הגרסאות של שפת התוכן של האתר.
ערכים (מופרדים באמצעות "|" או or תו חלופי): displaytitle, notificationtimestamp, preload, protection, subjectid, talkid, url, varianttitles, visitingwatchers, watched, watchers, readable
intestactions

בדיקה האם המשתמש הנוכחי יכול לבצע פעולות מסוימות על הדף.

הפרדה בין ערכים נעשית באמצעות | או תו חלופי.
המספר המרבי של ערכים הוא 50 (או 500 עבור לקוחות שמותרות להם מגבלות גבוהות יותר).
intestactionsdetail

רמת פירוט של intestactions. יש להשתמש בפרמטרים errorformat ו־errorlang של המודול הראשי כדי לשלוט בתסדיר את ההודעות המוחזרות.

boolean
החזרת ערך בוליאני עבור כל פעולה.
full
החזרת הודעות שמתארות למה הפעולה אינה מותרת, או מערך ריק אם היא מותרת.
quick
כמו full, אבל בלי בדיקות יקרות.
אחד מהערכים הבאים: boolean, full, quick
ברירת המחדל: boolean
intoken
מיושן.

להשתמש ב־action=query&meta=tokens במקום.

ערכים (מופרדים באמצעות "|" או or תו חלופי): block, delete, edit, email, import, move, protect, unblock, watch
incontinue

כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.

דוגמאות:
קבלת מידע על הדף Main Page
api.php?action=query&prop=info&titles=Main%20Page [פתיחה בארגז חול]
קבלת מידע כללי ומידע על הגנה של הדף Main Page.
api.php?action=query&prop=info&inprop=protection&titles=Main%20Page [פתיחה בארגז חול]

list=categorymembers (cm)

  • יחידה זו דורשת הרשאות קריאה.
  • אפשר להשתמש ביחידה הזאת בתור מחולל.
  • מקור: MediaWiki
  • רישיון: GPL-2.0-or-later

רשימת כל הדפים בקטגוריה נתונה.

פרמטרים:
cmtitle

איזו קטגוריה למנות (נדרש). חייב לכלול את התחילית קטגוריה:. לא יכול לשמש יחד עם cmpageid.

cmpageid

מזהה הדף של הקטגוריה שצריך למנות. לא יכול לשמש יחד עם cmtitle.

סוג: מספר שלם
cmprop

אילו חלקי מידע לכלול:

ids
הוספת מזהה הדף.
title
הוספת השם ומזהה מרחב השם של הדף.
sortkey
הוספת מפתח המיון שמשמש למיון בקטגוריה (מחרזות הקסדצימלית).
sortkeyprefix
הוספת מפתח המיון שמשמש למיון בקטגוריה (מחרוזת הקסדצימלית).
type
הוספת הסוג שהדף מוין אליו (page‏, subcat או file).
timestamp
הוספת חותם־הזמן שבו הדף נכלל.
ערכים (מופרדים באמצעות "|" או or תו חלופי): ids, sortkey, sortkeyprefix, timestamp, title, type
ברירת המחדל: ids|title
cmnamespace

לכלול רק דפים במרחבי השם האלה. יש לשים לב לכך ש־cmtype=subcat או cmtype=file יכולים לשמש במקום cmnamespace=14 או 6.

ערכים (מופרדים באמצעות "|" או or תו חלופי): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
כדי לתת את כל הערכים, יש להשתמש ב־*.
cmtype

איזה סוג של חברי קטגוריה לכלול. לא תקף כאשר מוגדר cmsort=timestamp.

ערכים (מופרדים באמצעות "|" או or תו חלופי): file, page, subcat
ברירת המחדל: page|subcat|file
cmcontinue

כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.

cmlimit

מספר הדפים המרבי שיוחזר.

סוג: מספר שלם או max
הערך חייב להיות בין 1 ל־500.
ברירת המחדל: 10
cmsort

לפי איזה מאפיין למיין.

אחד מהערכים הבאים: sortkey, timestamp
ברירת המחדל: sortkey
cmdir

באיזה כיוון למיין.

אחד מהערכים הבאים: asc, ascending, desc, descending, newer, older
ברירת המחדל: ascending
cmstart

מאיזה חותם־זמן להתחיל לרשום. יכול לשמש רק עם cmsort=timestamp.

סוג: חותם־זמן (תסדירים מורשים)
cmend

באיזה חותם־זמן לסיים לרשום. יכול לשמש רק עם cmsort=timestamp.

סוג: חותם־זמן (תסדירים מורשים)
cmstarthexsortkey

מפתח מיון להתחיל לרשום ממנו, כפי שמוחזר על־ידי cmprop=sortkey</kbd. יכול לשמש רק עם cmsort=sortkey.

cmendhexsortkey

מפתח מיון לסיים לרשום ממנו, כפי שמוחזר על־ידי cmprop=sortkey. יכול לשמש רק עם cmsort=sortkey.

cmstartsortkeyprefix

תחילית מפתח מיון להתחיל לרשום ממנה. יכול לשמש רק עם cmsort=sortkey. דורס את cmstarthexsortkey.

cmendsortkeyprefix

תחילית מפתח מיון שהרשימה תסתיים לפניה (לא בה, אם הערך הזה מוגדר, הוא לא ייכלל!). יכול לשמש רק עם cmsort=sortkey. דורס את cmendhexsortkey.

cmstartsortkey
מיושן.

כדאי להשתמש ב־cmstarthexsortkey במקום.

cmendsortkey
מיושן.

כדאי להשתמש ב־cmendhexsortkey במקום.

דוגמאות:
קבלת עשרת העמודים הראשונים שתחת Category:Physics.
api.php?action=query&list=categorymembers&cmtitle=Category:Physics [פתיחה בארגז חול]
קבל מידע על הדף עבור 10 הדפים הראשונים ב־Category:Physics.
api.php?action=query&generator=categorymembers&gcmtitle=Category:Physics&prop=info [פתיחה בארגז חול]