עזרה של MediaWiki API
זהו דף תיעוד של API שנוצר באופן אוטומטי.
תיעוד ודוגמאות: https://www.mediawiki.org/wiki/API
prop=info (in)
- יחידה זו דורשת הרשאות קריאה.
- מקור: MediaWiki
- רישיון: GPL-2.0+
קבלת מידע בסיסי על הדף.
- inprop
אילו מאפיינים נוספים לקבל:
- protection
- לרשום את רמת ההגנה של כל דף.
- talkid
- מזהה הדף של דף השיחה עבור כל דף שאינו דף שיחה.
- watched
- לרשום את מצב המעקב של כל דף.
- watchers
- מספר העוקבים, אם קיבלת הרשאה.
- notificationtimestamp
- חותם־זמן של הודעת רשימת מעקב של כל דף.
- subjectid
- מזהה הדף של הדף העיקרי של כל דף שיחה.
- url
- נותן URL מלא, URL לעריכה ו־URL קנוני לכל דף.
- readable
- האם המשתמש יכול להציג דף זה.
- preload
- נותן את הטקסט שמוחזר על־ידי EditFormPreloadText.
- displaytitle
- נותן את האופן שבה שם הדף באמת מוצג.
- ערכים (מופרדים באמצעות "|"): protection, talkid, watched, watchers, notificationtimestamp, subjectid, url, readable, preload, displaytitle
- intestactions
בדיקה האם המשתמש הנוכחי יכול לבצע פעולות מסוימות על הדף.
- הפרדה בין ערכים נעשית באמצעות | מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
- intoken
- מיושן.
להשתמש ב־action=query&meta=tokens במקום.
- ערכים (מופרדים באמצעות "|"): edit, delete, protect, move, block, unblock, email, import, 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+
רשימת כל הדפים בקטגוריה נתונה.
- cmtitle
איזו קטגוריה למנות (נדרש). חייב לכלול את התחילית קטגוריה:. לא יכול לשמש יחד עם cmpageid.
- cmpageid
מזהה הדף של הקטגוריה שצריך למנות. לא יכול לשמש יחד עם cmtitle.
- סוג: מספר שלם
- cmprop
אילו חלקי מידע לכלול:
- ids
- הוספת מזהה הדף.
- title
- הוספת השם ומזהה מרחב השם של הדף.
- sortkey
- הוספת מפתח המיון שמשמש למיון בקטגוריה (מחרזות הקסדצימלית).
- sortkeyprefix
- הוספת מפתח המיון שמשמש למיון בקטגוריה (מחרוזת הקסדצימלית).
- type
- הוספת הסוג שהדף מוין אליו (דף, תת־קטגוריה, או קובץ).
- timestamp
- הוספת חותם־הזמן שבו הדף נכלל.
- ערכים (מופרדים באמצעות "|"): ids, title, sortkey, sortkeyprefix, type, timestamp
- ברירת מחדל: ids|title
- cmnamespace
לכלול רק דפים במרחבי השם האלה. יש לשים לב לכך ש־cmtype=subcat או cmtype=file יכולים לשמש במקום cmnamespace=14 או 6.
- ערכים (מופרדים באמצעות "|"): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
- cmtype
איזה סוג של חברי קטגוריה לכלול. לא תקף כאשר מוגדר cmsort=timestamp.
- ערכים (מופרדים באמצעות "|"): page, subcat, file
- ברירת מחדל: page|subcat|file
- cmcontinue
כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.
- cmlimit
מספר הדפים המרבי שיוחזר.
- המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
- סוג: מספר שלם או max
- ברירת מחדל: 10
- cmsort
לפי איזה מאפיין למיין.
- אחד מהערכים הבאים: sortkey, timestamp
- ברירת מחדל: sortkey
- cmdir
באיזה כיוון למיין.
- אחד מהערכים הבאים: asc, desc, ascending, 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 במקום.
- קבלת עשרת העמודים הראשונים שתחת קטגוריה:פיזיקה.
- api.php?action=query&list=categorymembers&cmtitle=Category:Physics
- קבל מידע על הדף עבור 10 הדפים הראשונים ב־Category:Physics.
- api.php?action=query&generator=categorymembers&gcmtitle=Category:Physics&prop=info