API:Query/he

מאפשר לקבל מידע על אתר הוויקי ואת הנתונים ששמורים בו, כגון קוד הוויקי של דף מסוים, קישורים וקטגוריות במקבץ של דפים או האסימון שמאפשר.



תיעוד API


מודולים עבור שאילתות
מודול השאילתה כולל שלושה סוגים של תת־מודולים (נקראים גם מודולי שאילתה):


 * אודות אתר הוויקי והמשתמש המחובר.
 * של דפים, כולל גרסאות דפים ותוכן.
 * של דפים שתואמים קריטריון מסוים.

דוגמאות


דוגמה 1: ציון דפים
בשונה ממודולי ה־meta וה־list במודול השאילתה, כל מודולי השאילתה שמתייחסים למאפיינים עובדים עם מקבץ של דפים שניתן לציין באחת מהדרכים הבאות:


 * לפי שם תוך שימוש בפרמטר, לדוגמה.
 * לפי מזהה הדף (ID) תוך שימוש בפרמטר, לדוגמה.
 * לפי מזהה גרסה תוך שימוש בפרמטר, למשל  . רוב מודולי השאילתה יהפכו את מזהה הגרסה למזהה הדף המתאים. רק  משתמש בפועל במזהה הגרסה.
 * שימוש בגנרטור.



Example 2: Title normalization
Title normalization converts page titles to their canonical form.

This means capitalizing the first character, replacing underscores with spaces, and changing namespace to the localized form defined for that wiki.



תשובה


דוגמה 3: כותרות שגויות או חסרות
כותרות שאינן קיימות או שהן בלתי־תקינות יכללו מאפיין  או   בתשובה.

In output formats that support numeric array keys, missing and invalid titles will have negative page IDs.

In some cases, a title can be viewed by a user but cannot be accessed by the API, such as pages that mirror content from another wiki. These titles will have a  attribute set in the response.



תשובה


דוגמה 4: שאילתות נוספות
כאשר כל הנתונים לא מוחזרים בתשובה של השאילתה, לעיתים יתווסף המאפיין  על מנת להודיע שיש נתונים נוספים.



תשובה
כדי לקבל נתונים נוספים, יש להוסיף את הערכים שלהם לבקשה הראשונה.

Response


דוגמה 5: אחזור שהסתיים (Batchcomplete)
ה־API מחזיר אלמנט  כדי לציין שכל הנתונים של האחזור הנוכחי הוחזרו.

בתשובה של השאילתה להלן,  נכלל כדי לציין שכל הנתונים של כל אחת משלושת התמונות הוחזרו.

ההמשך הבא יתחיל בהחזרת 3 התמונות הבאות.



תשובה


דוגמה 6: גנרטורים
Use generators if you want to get data about a set of pages.

For example, to get data about pages in a certain category, instead of querying  and then querying again with   set to all the returned pages, combine the two API calls into one by using.

When using a list module as a generator, you don't need to specify the pages.

However, for a property module, you should specify the pages which the generator will work on.

For example, to load all pages that are linked to from the main page, use.

Parameters passed to a generator must be prefixed with a. For instance, when using, use   instead of.

The sample query below gets links and categories for the first three pages in the main namespace starting with "Ba".



Continuing queries
Queries will often have more results available than are just shown in the original query. (Often this is because a List query's result limit has been reached.) In these cases, queries can be continued. More detailed information on continuing queries can be at API:Continue.



Parameter history

 * v1.21: Introduced
 * v1.24: Introduced (note raw continuation was the default behavior until v1.26)



הערות נוספות

 * ציון כותרות באמצעות  או   מוגבל ל־50 כותרות עבור כל שאילתה, או 500 עבור משתמשים שמחזיקים בהרשאה.
 * ניתן להשתמש בכמה מודולי שאילתה ביחד כדי לקבל את מה שאתם צריכים תוך ביצוע שאילתה אחת, לדוגמה.
 * Generators always pass page titles to the query module. Unlike lists (which may include additional data by default), generators should not output any information themselves, unless when explicitly requested via the generator module's query parameters.

Resolving redirects
Redirects can be resolved automatically, so that the target of a redirect is returned instead of the given title. When present, they will always contain  and   attributes and may contain a   attribute for those redirects that point to specific sections.

Both normalization and redirection may take place. In the case of multiple redirects, all redirects will be resolved, and in case of a circular redirect, there might not be a page in the 'pages' section (see also below). Redirect resolution cannot be used in combination with the  parameter or with a generator generating revids; doing that will produce a warning and will not resolve redirects for the specified revids.

The examples below show how the  parameter works.



ראו גם

 * - מדריך ההתחלה המהירה.
 * - מכיל מידע אודות אופן השימוש בפרמטר.