API:Vlastnosti
Tato stránka je součástí dokumentace k API Action MediaWiki. |
Požadavek GET pro výpis vlastností vybraných stránek.
Dokumentace API
Vlastnosti jsou data o stránce, jako jsou kategorie, nebo obsah na stránce, jako jsou obrázky nebo odkazy.
Chcete-li požádat o vlastnost, předáte parametru prop
vašeho dotazu platný submodul vlastnosti, který odpovídá informacím, které potřebujete.
Stránka nebo stránky, jejichž data požadujete, jsou specifikovány buď titles
, pageids
, nebo revids
parametry dotazu, nebo pomocí zdroje .
Dotazy na vlastnosti se zapisují takto: action=query&titles=title1&prop=property1|property2
.
Dotazy na vlastnosti mají vždy omezený počet vrácených položek.
Chcete-li zobrazit více položek, připojte hodnoty uvnitř prvku continue
výsledku k původnímu požadavku.
Konkrétní příklady použití vlastností naleznete na stránkách API jednotlivých služeb:
Další poznámky
- Většinu submodulů vlastností lze použít jako zdroje , pokud není uvedeno jinak.
- Limity dotazů na vlastnosti:
- Výsledky pro dotazy na vlastnosti mají vždy limit. Výchozí limit je 10. Limit výsledků lze nastavit až na 500 pro běžné uživatele nebo 5000 pro uživatele s právem
apihighlimits
(obvykle boti a sysopové). Některé moduly ukládají za určitých podmínek přísnější limity. - Pokud si nejste jisti, který limit se na vás vztahuje, a chcete jen co nejvíce výsledků, nastavte limit na
max
. V takovém případě bude vrácen prveklimits
s uvedením použitých limitů. - Parametr limit pro daný modul se skládá z prefixu modulu následovaného slovem
limit
. Napříkladimlimit
je maximální počet vrácenýchimages
.
- Výsledky pro dotazy na vlastnosti mají vždy limit. Výchozí limit je 10. Limit výsledků lze nastavit až na 500 pro běžné uživatele nebo 5000 pro uživatele s právem
Související odkazy
- Dokumentace k modulu dotazu - obsahuje stručný popis všech submodulů vlastností, jejich odpovídajících parametrů a hodnot.
- API:Databázové pole a přidružení vlastností API - obsahuje tabulku popisující, jak jsou vlastnosti dotazu přidruženy k polím v databázi MediaWiki .
- API:Seznamy - podobné API pro přístup k seznamům informací, jako je
allusers
neborecentchanges
. Na rozdíl od dotazů na vlastnosti, které připojují data k prvkupages
, seznamy vracejí samostatnou větev v prvkuquery
.
- Spravováno MediaWiki Interfaces Team.
- Živý chat (IRC): #mediawiki-core připojit se
- Nástroj pro sledování problémů: Phabricator MediaWiki-Action-API (nahlášení problému)