עזרה של MediaWiki API

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

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

prop=info (in)

  • יחידה זו דורשת הרשאות קריאה.

Get basic page information.

פרמטרים:
inprop

Which additional properties to get:

protection
List the protection level of each page.
talkid
The page ID of the talk page for each non-talk page.
watched
List the watched status of each page.
watchers
מספר העוקבים, אם קיבלת הרשאה.
notificationtimestamp
The watchlist notification timestamp of each page.
subjectid
The page ID of the parent page for each talk page.
url
Gives a full URL, an edit URL, and the canonical URL for each page.
readable
האם המשתמש יכול להציג דף זה.
preload
Gives the text returned by EditFormPreloadText.
displaytitle
Gives the way the page title is actually displayed.
ערכים (מופרדים באמצעות "|"): protection, talkid, watched, watchers, notificationtimestamp, subjectid, url, readable, preload, displaytitle
intestactions

Test whether the current user can perform certain actions on the page.

הפרדה בין ערכים נעשית באמצעות | מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
intoken
מיושן.

Use action=query&meta=tokens instead.

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

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

דוגמאות:
Get information about the page Main Page.
api.php?action=query&prop=info&titles=Main%20Page
Get general and protection information about the page Main Page.
api.php?action=query&prop=info&inprop=protection&titles=Main%20Page

list=categorymembers (cm)

  • יחידה זו דורשת הרשאות קריאה.
  • היחידה הזאת יכולה להיות מחולל.

List all pages in a given category.

פרמטרים:
cmtitle

Which category to enumerate (required). Must include the קטגוריה: prefix. Cannot be used together with cmpageid.

cmpageid

Page ID of the category to enumerate. Cannot be used together with cmtitle.

cmprop

Which pieces of information to include:

ids
Adds the page ID.
title
Adds the title and namespace ID of the page.
sortkey
Adds the sortkey used for sorting in the category (hexadecimal string).
sortkeyprefix
Adds the sortkey prefix used for sorting in the category (human-readable part of the sortkey).
type
Adds the type that the page has been categorised as (page, subcat or file).
timestamp
Adds the timestamp of when the page was included.
ערכים (מופרדים באמצעות "|"): ids, title, sortkey, sortkeyprefix, type, timestamp
ברירת מחדל: ids|title
cmnamespace

Only include pages in these namespaces. Note that cmtype=subcat or cmtype=file may be used instead of cmnamespace=14 or 6.

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

Which type of category members to include. Ignored when cmsort=timestamp is set.

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

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

cmlimit

The maximum number of pages to return.

המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
ברירת מחדל: 10
cmsort

Property to sort by.

ערך אחד: sortkey, timestamp
ברירת מחדל: sortkey
cmdir

In which direction to sort.

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

Timestamp to start listing from. Can only be used with cmsort=timestamp.

cmend

Timestamp to end listing at. Can only be used with cmsort=timestamp.

cmstarthexsortkey

Sortkey to start listing from, as returned by cmprop=sortkey. Can only be used with cmsort=sortkey.

cmendhexsortkey

Sortkey to end listing from, as returned by cmprop=sortkey. Can only be used with cmsort=sortkey.

cmstartsortkeyprefix

Sortkey prefix to start listing from. Can only be used with cmsort=sortkey. Overrides cmstarthexsortkey.

cmendsortkeyprefix

Sortkey prefix to end listing BEFORE (not at, if this value occurs it will not be included!). Can only be used with cmsort=sortkey. Overrides cmendhexsortkey.

cmstartsortkey
מיושן.

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

cmendsortkey
מיושן.

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

דוגמאות:
קבלת עשרת העמודים הראשונים שתחת קטגוריה:פיזיקה.
api.php?action=query&list=categorymembers&cmtitle=Category:Physics
Get page info about first 10 pages in Category:Physics.
api.php?action=query&generator=categorymembers&gcmtitle=Category:Physics&prop=info