API:Query/cs

Modul  vám umožňuje získat informace o wiki a datech v ní uložených, jako je wikitext konkrétní stránky, odkazy a kategorie sady stránek nebo token, který potřebujete ke.



Dokumentace API


Moduly dotazů
Modul dotazu má tři typy podmodulů (nazývaných také dotazovací moduly):


 * o wiki a přihlášeném uživateli.
 * stránek, včetně revizí stránek a obsahu.
 * stránek, které odpovídají určitým kritériím.

Příklady


Příklad 1: Určení stránek
Na rozdíl od modulů meta a dotazů na seznam fungují všechny moduly dotazů na vlastnosti na sadě stránek, které lze zadat jedním z následujících způsobů:


 * Podle jména pomocí parametru, např..
 * Podle ID stránky pomocí parametru, např..
 * Podle ID revize pomocí parametru, např.  . Většina dotazovacích modulů převede ID revize na odpovídající ID stránky. Pouze  ve skutečnosti používá samotné ID revize.
 * Pomocí generátoru.



Odpověď


Příklad 2: Normalizace názvu
Normalizace nadpisů převede nadpisy stránek do jejich kanonické podoby.

To znamená použití velkého prvního znaku, nahrazení podtržítek mezerami a změnu jmenného prostoru na lokalizovaný tvar definovaný pro danou wiki.



Odpověď


Příklad 3: Chybějící a neplatné názvy
Názvy, které neexistují nebo jsou neplatné, budou mít v odpovědi nastaven atribut  nebo.

Ve výstupních formátech, které podporují klávesy číselných polí, budou mít chybějící a neplatné názvy záporné ID stránky.

V některých případech může uživatel zobrazit název, ale nemůže k němu přistupovat rozhraní API, jako jsou stránky, které zrcadlí obsah z jiné wiki. Tyto tituly budou mít v odpovědi nastavený atribut.



Odpověď


Příklad 4: Pokračující dotazy
Když nejsou v odpovědi na dotaz vrácena všechna data, bude zde atribut, který značí, že existuje více dat.



Odpověď
Chcete-li získat další data, přidejte jejich hodnoty k původnímu požadavku:



Odpověď


Příklad 5: Dokončení dávky
The API returns a  element to indicate that all data for the current batch of items has been returned.

In the response of the sample query below,  has been included to indicate that all the data for each of the three images has been returned.

The next continuation will begin returning data for the next set of 3 images.

Example 6: Generators
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.34: Introduced
 * v1.24: Introduced (note: raw continuation was the default behavior until v1.26)
 * v1.21: Introduced

Additional notes

 * Specifying titles through  or   is limited to 50 titles per query, or 500 for those with the   right.
 * Use multiple query modules together to get what you need in one request, e.g..
 * 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.