MediaWiki-API-hjelp

Dette er en automatisk generert MediaWiki-API-dokumentasjonsside.

Dokumentasjon og eksempler: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page

prop=info (in)

(main | query | info)

Denne modulen krever lesetilgang.
Kilde: MediaWiki
Lisens: GPL-2.0-or-later

Hent grunnleggende sideinformasjon.

https://www.mediawiki.org/wiki/Special:MyLanguage/API:Info

Spesifikke parametre:

Andre generelle parametre er tilgjengelige.

inprop

Hvilke ekstra egenskaper som skal hentes:

protection: List opp beskyttelsesnivået til hver side.
talkid: Side-ID-en til diskusjonssidene for hver ikke-diskusjonsside.
watched: List opp overvåkningsstatusen til hver side.
watchers: Antall overvåkere, hvis det tillates.
visitingwatchers: Antall overvåkende av hver side som har besøkt de siste endringene på siden, hvis det tillates.
notificationtimestamp: Overvåkningsvarseltidsstempelet til hver side.
subjectid: Side-ID-en til foreldresiden til hver diskusjonsside.
associatedpage: Tittelen på den tilhørende tema- eller diskusjonssiden inkludert prefikset.
url: Gir den hele URL-en, en redigerings-URL og den kanoniske URL-en for hver side.
readable: Utgått. Hvorvidt brukeren kan lese denne siden. Bruk intestactions=read i stedet.
preload: Gir teksten returnert av EditFormPreloadText.
displaytitle: Gir måten sidetittelen faktisk vises.
varianttitles: Gir visningstittelen i alle varianter av nettstedets innholdsspråk.
linkclasses: Gir de tradisjonelle CSS-klassene (f.eks. lenkefarger) som brukes for lenker til denne siden hvis de skulle finnes på siden med navn inlinkcontext.

Verdier (separer med | eller alternativ): associatedpage, displaytitle, linkclasses, notificationtimestamp, preload, protection, subjectid, talkid, url, varianttitles, visitingwatchers, watched, watchers, readable

inlinkcontext

Konteksttittelen som skal brukes for å bestemme ekstra CSS-klasser (f.eks. lenkefarger) når inprop inneholder linkclasses.

Type: sidetittel

Godtar ikke-eksisterende sider.

Standard: Forside

intestactions

Test hvorvidt den gjeldende brukeren kan utføre visse handlinger på siden.

Separer verdier med | eller alternativ.

Maksimalt antall verdier er 50 (500 for klienter som er tillatt høyere grenser).

intestactionsdetail

Detaljnivå for intestactions. Bruk hovedmodulens errorformat og errorlang-parametre for å kontrollere formatet til beskjedene som returneres.

boolean: Returnerer en boolsk verdi for hver handling.
full: Returnerer beskjeder som beskriver hvorfor handlingen ikke tillates, eller en tom liste hvis den er tillatt.
quick: Som full, men hopper over dyre sjekker.

Én av følgende verdier: boolean, full, quick

Standard: boolean

incontinue

Når flere resultater er tilgjengelige, bruk denne for å fortsette. Mer detaljert informasjon om hvordan man kan fortsette spørringer finnes på mediawiki.org.

Eksempler:

Hent informasjon om siden Forside.: api.php?action=query&prop=info&titles=Forside [åpne i sandkasse]
Hent generell informasjon og beskyttelsesinformasjon om siden Forside.: api.php?action=query&prop=info&inprop=protection&titles=Forside [åpne i sandkasse]

list=categorymembers (cm)

(main | query | categorymembers)

Denne modulen krever lesetilgang.
Denne modulen kan brukes som en generator.
Kilde: MediaWiki
Lisens: GPL-2.0-or-later

List opp alle sider i en gitt kategori.

https://www.mediawiki.org/wiki/Special:MyLanguage/API:Categorymembers

Spesifikke parametre:

Andre generelle parametre er tilgjengelige.

cmtitle

Hvilken kategori som skal gås gjennom. Må inkludere prefikset Kategori:. Kan ikke brukes sammen med cmpageid.

cmpageid

Side-ID-en til kategorien som skal gås gjennom. Kan ikke brukes sammen med cmtitle.

Type: heltall

cmprop

Hvilken informasjon som skal inkluderes:

ids: Legger til side-ID-en.
title: Legger til tittel- og navneroms-ID-en til siden.
sortkey: Legger til sorteringsnøkkelen for sortering i kategorien (heksadesimal streng).
sortkeyprefix: Legger til sorteringsnøkkelprefikset for sortering i kategorien (menneskeleselig del av sorteringsnøkkelen).
type: Legger til typen siden har blitt kategorisert som (page, subcat eller file).
timestamp: Legger til tidsstempelet for når siden ble inkludert.

Verdier (separer med | eller alternativ): ids, sortkey, sortkeyprefix, timestamp, title, type

Standard: ids|title

cmnamespace

Bare inkluder sider i disse navnerommene. Merk at cmtype=subcat eller cmtype=file kan brukes i stedet for cmnamespace=14 eller 6.

Verdier (separer med | eller alternativ): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 2300, 2301, 2302, 2303

For å angi alle verdier, bruk *.

cmtype

Hvilken type kategorimedlemmer som skal inkluderes. Ignoreres når cmsort=timestamp er satt.

Verdier (separer med | eller alternativ): file, page, subcat

Standard: page|subcat|file

cmcontinue

Når flere resultater er tilgjengelige, bruk denne for å fortsette. Mer detaljert informasjon om hvordan man kan fortsette spørringer finnes på mediawiki.org.

cmlimit

Maksimalt antall sider som skal returneres.

Type: heltall eller max

Verdien må være mellom 1 og 500.

Standard: 10

cmsort

Egenskap det skal sorteres etter.

Én av følgende verdier: sortkey, timestamp

Standard: sortkey

cmdir

Hvilken retning det skal sorteres i.

Én av følgende verdier: asc, ascending, desc, descending, newer, older

Standard: ascending

cmstart

Tidsstempel det skal listes opp fra. Kan bare brukes med cmsort=timestamp.

Type: tidsstempel (tillatte formater)

cmend

Tidsstempel det skal listes opp til. Kan bare brukes med cmsort=timestamp.

Type: tidsstempel (tillatte formater)

cmstarthexsortkey

Sorteringsnøkkel det skal listes opp fra, som returnert av cmprop=sortkey. Kan bare brukes med cmsort=sortkey.

cmendhexsortkey

Sorteringsnøkkel det skal listes opp til, som returnert av cmprop=sortkey. Kan bare brukes med cmsort=sortkey.

cmstartsortkeyprefix

Sorteringsnøkkelprefiks det skal listes opp fra. Kan bare brukes med cmsort=sortkey. Overstyrer cmstarthexsortkey.

cmendsortkeyprefix

Sorteringsnøkkelprefiks opplistingen skal avsluttes foran (ikke ved; hvis denne verdien finnes blir den ikke inkludert!). Kan bare brukes med cmsort=sortkey. Overstyrer cmendhexsortkey.

cmstartsortkey

Utgått.

Bruk cmstarthexsortkey i stedet.

cmendsortkey

Utgått.

Bruk cmendhexsortkey i stedet.

Eksempler:

Hent de første 10 sidene i Category:Physics.: api.php?action=query&list=categorymembers&cmtitle=Category:Physics [åpne i sandkasse]
Hent sideinformasjon om de første 10 sidene i Category:Physics.: api.php?action=query&generator=categorymembers&gcmtitle=Category:Physics&prop=info [åpne i sandkasse]