MediaWiki-API-Hilfe – Wikipedia (original) (raw)

Dies ist eine automatisch generierte MediaWiki-API-Dokumentationsseite.

Dokumentation und Beispiele: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page

Hauptmodul

Status: Die MediaWiki-API ist eine ausgereifte und stabile Schnittstelle, die aktiv unterstützt und verbessert wird. Während wir versuchen, dies zu vermeiden, können wir gelegentlich Breaking Changes erforderlich machen. Abonniere die MediaWiki-API-Ankündigungs-Mailingliste für Mitteilungen zu Aktualisierungen.

Fehlerhafte Anfragen: Wenn fehlerhafte Anfragen an die API gesendet werden, wird ein HTTP-Header mit dem Schlüssel „MediaWiki-API-Error“ gesendet. Der Wert des Headers und der Fehlercode werden auf den gleichen Wert gesetzt. Für weitere Informationen siehe API: Fehler und Warnungen.

Testen: Zum einfachen Testen von API-Anfragen, siehe Special:ApiSandbox.

Spezifische Parameter:

action

Auszuführende Aktion.

abusefiltercheckmatch

Prüfen, ob ein Missbrauchsfilter mit einem Satz von Variablen, einer Bearbeitung oder einem protokollierten Missbrauchsfilter-Ereignis übereinstimmt.

abusefilterchecksyntax

Überprüft die Syntax eines Missbrauchfilters.

abusefilterevalexpression

Bewertet einen Ausdruck des Missbrauchfilters.

abusefilterunblockautopromote

Verhindert, dass ein Benutzer aufgrund einer Missbrauchsfilter-Folge Autopromotions erhält.

abuselogprivatedetails

Private Details des AbuseLog-Eintrags ansehen.

acquiretempusername

Erfasst einen temporären Benutzernamen und speichert diesen in der aktuellen Sitzung, wenn die Erstellung von temporären Konten aktiviert und der aktuelle Benutzer abgemeldet ist. Wenn ein Name bereits gespeichert wurde, wird derselbe Name zurückgegeben.

antispoof

Einen Benutzernamen in die Normalisierungsprüfung der Erweiterung AntiSpoof aufnehmen.

block

Sperrt einen Benutzer.

centralauthtoken

Holt einen zentralen Authtoken, um eine authentifizierte Anfrage an ein verbundenes Wiki zu erstellen.

centralnoticecdncacheupdatebanner

Fragt die Löschung des Vorlageninhalts an, der im CDN-Cache (Frontend-Cache) für anonyme Benutzer gespeichert ist, für die gewünschte Vorlage und Sprache.

centralnoticechoicedata

Ruft erforderliche Daten zur Auswahl einer Vorlage für ein angegebenes Projekt und eine Sprache ab

centralnoticequerycampaign

Ruft alle Konfigurationseinstellungen für eine Kampagne ab.

changeauthenticationdata

Ändert die Authentifizierungsdaten für den aktuellen Benutzer.

changecontentmodel

Inhaltsmodell einer Seite ändern

checktoken

Überprüft die Gültigkeit eines über action=query&meta=tokens erhaltenen Tokens.

cirrus-config-dump

Auszug der CirrusSearch-Konfiguration.

cirrus-mapping-dump

Speicherauszug der CirrusSearch-Zuordnungen für dieses Wiki.

cirrus-profiles-dump

Auszug der CirrusSearch-Profile für dieses Wiki.

cirrus-settings-dump

Auszug der CirrusSearch-Einstellungen für dieses Wiki.

clearhasmsg

Löschen des hasmsg-Flags („hat Nachrichten“-Flag) für den aktuellen Benutzer.

clientlogin

Melde dich bei dem Wiki mit dem interaktiven Ablauf an.

communityconfigurationedit

Change the content of a configuration provider in Community configuration

compare

Ruft den Unterschied zwischen zwei Seiten ab.

createaccount

Erstellt ein neues Benutzerkonto.

createlocalaccount

Erstellung eines lokalen Benutzerkontos erzwingen. Das globale Konto muss existieren.

cxdelete

Löscht einen Übersetzungsentwurf, der mit der Softwareerweiterung „Content Translation“ erstellt wurde.

cxsuggestionlist

Verwaltet die Vorschlagslisten. Ergänzt Vorschläge in der Liste und entfernt sie.

cxtoken

Ruft JWT-Token zur Authentifizierung mit dem cxserver ab.

delete

Löscht eine Seite.

deleteglobalaccount

Löscht einen globalen Benutzer.

discussiontoolsedit

Veröffentlichen einer Nachricht auf einer Diskussionsseite.

discussiontoolsfindcomment

Einen Kommentar anhand seiner ID oder seines Namens suchen.

discussiontoolsgetsubscriptions

Ermittelt den Abonnementstatus der angegebenen Themen.

discussiontoolssubscribe

Abonnieren (oder abbestellen), um Benachrichtigungen über ein Thema zu erhalten.

discussiontoolsthank

Senden einer öffentliche Dankesbenachrichtigung für einen Kommentar.

echocreateevent

Manuelles Auslösen einer Benachrichtigung an einen Benutzer

echomarkread

Markiert Benachrichtigungen für den aktuellen Benutzer als gelesen.

echomarkseen

Markiert Benachrichtigungen für den aktuellen Benutzer als gesehen.

echomute

Stummschalten oder Aufheben der Stummschaltung von Benachrichtigungen bestimmter Benutzer oder Seiten.

edit

Erstellen und Bearbeiten von Seiten.

editmassmessagelist

Bearbeitet eine Massennachrichten-Versandliste.

emailuser

E-Mail an einen Benutzer senden.

expandtemplates

Alle Vorlagen innerhalb des Wikitextes expandieren.

featuredfeed

Gibt einen Feed mit vorgestelltem Inhalt zurück.

feedcontributions

Gibt einen Benutzerbeiträge-Feed zurück.

feedrecentchanges

Gibt einen Letzte-Änderungen-Feed zurück.

feedwatchlist

Gibt einen Beobachtungslisten-Feed zurück.

filerevert

Eine Datei auf eine alte Version zurücksetzen.

flagconfig

Erhalte grundlegende Informationen über die Konfiguration der Prüfkennzeichen für diese Seite.

globalblock

Sperrt global einen Benutzer oder gibt ihn frei.

globalpreferenceoverrides

Ändert lokale Umgehungen für globale Einstellungen für den aktuellen Benutzer.

globalpreferences

Ändert die globalen Einstellungen des aktuellen Benutzers.

globaluserrights

Fügt einen Benutzer zu globalen Gruppen hinzu oder entfernt ihn aus diesen.

growthmanagementorlist

Verwalten der Informationen in der strukturierten Lotsenliste (normalerweise gespeichert in MediaWiki:GrowthMentors.json). Dieses Modul kann sowohl von aktuellen als auch zukünftigen Lotsen (um sich selbst hinzuzufügen oder ihre Daten zu ändern) und Administratoren (für alle Benutzer) verwendet werden.

growthmentordashboardupdatedata

Planen einer außerplanmäßigen Aktualisierung des Mentee-Übersichtsmoduls auf der Lotsen-Verwaltungsseite. Du kannst aus Leistungsgründen nur eine Aktualisierung alle zwei Stunden planen.

growthsetmenteestatus

Mentee-Status festlegen (ermöglicht Mentees, das Lotsen-Modul zu aktivieren/deaktivieren oder sich vollständig abzumelden, wodurch die Mentee/Lotsen-Beziehung gelöscht wird)

growthsetmentor

Lege die Lotsin/den Lotsen des Benutzers fest. Änderungen werden öffentlich protokolliert.

growthstarmentee

Setzen oder Aufheben der Sternchen-Markierung eines Mentees durch den aktuellen Benutzer (privat gespeichert und nicht protokolliert)

help

Hilfe für die angegebenen Module anzeigen.

homepagequestionstore

Ruft formatierte Fragen ab, die über die Startseiten-Module gepostet wurden.

imagerotate

Dieses Modul wurde deaktiviert.

import

Importiert eine Seite aus einem anderen Wiki oder von einer XML-Datei.

jsonconfig

Erlaubt direkten Zugriff auf das JsonConfig-Untersystem.

languagesearch

Sucht nach Sprachnamen in einem beliebigen Skript.

linkaccount

Verbindet ein Benutzerkonto von einem Drittanbieter mit dem aktuellen Benutzer.

login

Anmelden und Authentifizierungs-Cookies beziehen.

logout

Abmelden und alle Sitzungsdaten löschen.

managetags

Ermöglicht Verwaltungsaufgaben zu Änderungsmarkierungen.

massmessage

Sendet eine Nachricht an eine Liste von Seiten.

mergehistory

Führt Versionsgeschichten von Seiten zusammen.

move

Eine Seite verschieben.

opensearch

Das Wiki mithilfe des OpenSearch-Protokolls durchsuchen.

options

Die Voreinstellungen des gegenwärtigen Benutzers ändern.

paraminfo

Ruft Informationen über API-Module ab.

parse

Parst den Inhalt und gibt die Parserausgabe zurück.

patrol

Kontrolliert eine Seite oder Version.

protect

Ändert den Schutzstatus einer Seite.

purge

Setzt den Cache der angegebenen Seiten zurück.

query

Bezieht Daten von und über MediaWiki.

removeauthenticationdata

Remove authentication data for the current user.

resetpassword

Send a password reset email to a user.

review

Überprüfe eine Überarbeitung, indem du sie genehmigst oder nicht genehmigst.

revisiondelete

Löscht und stellt Versionen wieder her.

rollback

Setzt die letzte Bearbeitung der Seite zurück.

rsd

Ein RSD-Schema (Really Simple Discovery) exportieren.

setglobalaccountstatus

Ein globales Benutzerkonto ausblenden oder sperren (bzw. einblenden oder entsperren).

setnotificationtimestamp

Update the notification timestamp for watched pages.

setpagelanguage

Ändert die Sprache einer Seite.

shortenurl

Kürzt eine lange URL auf eine kürzere.

sitematrix

Ruft eine Liste der Wikimedia-Wikis ab.

spamblacklist

Überprüft eine oder mehrere URLs gegen die Spam-Negativliste.

stabilize

Ändert die Einstellungen für die Seitenstabilität.

streamconfigs

Zeigt die Konfiguration des Ereignisstroms an. Gibt nur format=json mit formatversion=2 zurück.

strikevote

Erlaubt es Administratoren, eine Stimme zu streichen oder ihre Streichung zurückzunehmen.

sxdelete

Löscht den Entwurf der Abschnittsübersetzung und die dazugehörigen Parallelkorpora aus der Datenbank.

tag

Add or remove change tags from individual revisions or log entries.

templatedata

Ruft Daten ab, die durch die Erweiterung „TemplateData“ gespeichert werden.

thank

Sendet eine Dankeschön-Benachrichtigung an einen Bearbeiter.

titleblacklist

Überprüft einen Seiten-, Datei- oder Benutzernamen gegen die Titel-Negativliste.

torblock

Prüfen, ob eine IP-Adresse als Tor-Ausgangsknoten gesperrt ist.

transcodereset

Benutzer mit dem Recht „transcode-reset“ können Umschlüsselungsaufträge zurücksetzen und neu starten.

unblock

Einen Benutzer freigeben.

undelete

Undelete revisions of a deleted page.

unlinkaccount

Remove a linked third-party account from the current user.

upload

Upload a file, or get the status of pending uploads.

userrights

Ändert die Gruppenzugehörigkeit eines Benutzers.

validatepassword

Validiert ein Passwort gegen die Passwortrichtlinien des Wikis.

watch

Add or remove pages from the current user's watchlist.

webapp-manifest

Gibt ein Webapp-Manifest zurück.

webauthn

API-Modul zur Kommunikation zwischen Server und Client während des Registrierungs-Authentifizierungsprozesses.

bouncehandler

Intern. Ruft eine Rückläufer-E-Mail ab und verarbeitet sie zur Bearbeitung des fehlgeschlagenen Empfängers.

categorytree

Intern. Internes Modul für die Erweiterung „CategoryTree“.

cirrus-check-sanity

Intern. Berichte über die Korrektheit eines Bereichs von Seiten-IDs im Suchindex

collection

Intern. API-Modul zur Durchführung verschiedener Operationen mit der Sammlung eines Wiki-Benutzers.

cspreport

Intern. Wird von Browsern verwendet, um Verstöße gegen die Content Security Policy zu melden. Dieses Modul sollte niemals verwendet werden, außer wenn es automatisch von einem CSP-konformen Webbrowser verwendet wird.

cxcheckunreviewed

Intern. Überprüfe, ob in letzter Zeit eine schnelle, nicht überprüfte Übersetzung für den aktuellen Benutzer veröffentlicht wurde.

cxpublish

Intern. Speichert eine Seite, die mithilfe der Erweiterung „Content Translation“ erstellt wurde.

cxpublishsection

Intern. Save a section created using the Content Translation extension's section translation feature.

cxsave

Intern. This module allows to save draft translations by section to save bandwidth and to collect parallel corpora.

cxsplit

Intern. Erstellen und Speichern einer Abschnittsübersetzung in der Datenbank, für jeden übersetzten Abschnitt der gegebenen Artikelübersetzung

discussiontoolscompare

Intern. Informationen über Kommentaränderungen zwischen zwei Seitenversionen abrufen.

discussiontoolspageinfo

Intern. Gibt Metadaten zurück, die zur Initialisierung der Diskussionswerkzeuge erforderlich sind.

discussiontoolspreview

Intern. Vorschau einer Nachricht auf einer Diskussionsseite.

echopushsubscriptions

Intern. Verwaltung der Push-Abonnements für den aktuellen Benutzer.

editcheckreferenceurl

Intern. Check the status of a URL for use as a reference.

fancycaptchareload

Intern. Ruft ein neues FancyCaptcha ab.

growthinvalidateimagerecommendation

Intern. Eine Bildempfehlung ungültig machen.

growthinvalidatepersonalizedpraisesuggestion

Intern. Ungültigmachung eines Vorschlags für einen lobenswerten Mentee im Modul personalisiertes Lob auf dem Lotsen-Dashboard

helppanelquestionposter

Intern. Bearbeitet Fragen, die über das Help-Panel des aktuellen Benutzers eingereicht wurden.

jsondata

Intern. Ruft lokalisierte JSON-Daten ab.

oathvalidate

Intern. Überprüft einen Token zur Zwei-Faktor-Authentifizierung (OATH).

parser-migration

Intern. Parst eine Seite mit zwei unterschiedlichen Parser-Konfigurationen.

readinglists

Intern. Schreiboperationen für die Leseliste.

sanitize-mapdata

Intern. Führt eine Datenvalidierung für die Erweiterung „Kartographer“ aus

scribunto-console

Intern. Internes Modul zur Verarbeitung von XHR-Anfragen der Scribunto-Konsole.

securepollauth

Intern. Ermöglicht es einem Remote-Wiki, Benutzer zu authentifizieren, bevor sie Zugang zur Wahl erhalten.

stashedit

Intern. Prepare an edit in shared cache.

sxsave

Intern. Speichert den Entwurf der Abschnittsübersetzung und speichert die parallelen Korpora

timedtext

Intern. Bietet „Timed Text“-Inhalte für die Nutzung durch $lt;track>-Elemente

ulslocalization

Intern. Ruft die Lokalisierung von ULS in der angegebenen Sprache ab.

ulssetlang

Intern. Update user's preferred interface language.

visualeditor

Intern. Gibt das HTML5 für eine Seite vom Parsoid-Dienst zurück.

visualeditoredit

Intern. Speichert eine HTML5-Seite zu MediaWiki (konvertiert zu Wikitext mithilfe des Parsoid-Dienstes).

wikimediaeventsblockededit

Intern. Protokollierung von Informationen über blockierte Bearbeitungsversuche

Einer der folgenden Werte: abusefiltercheckmatch, abusefilterchecksyntax, abusefilterevalexpression, abusefilterunblockautopromote, abuselogprivatedetails, acquiretempusername, antispoof, block, centralauthtoken, centralnoticecdncacheupdatebanner, centralnoticechoicedata, centralnoticequerycampaign, changeauthenticationdata, changecontentmodel, checktoken, cirrus-config-dump, cirrus-mapping-dump, cirrus-profiles-dump, cirrus-settings-dump, clearhasmsg, clientlogin, communityconfigurationedit, compare, createaccount, createlocalaccount, cxdelete, cxsuggestionlist, cxtoken, delete, deleteglobalaccount, discussiontoolsedit, discussiontoolsfindcomment, discussiontoolsgetsubscriptions, discussiontoolssubscribe, discussiontoolsthank, echocreateevent, echomarkread, echomarkseen, echomute, edit, editmassmessagelist, emailuser, expandtemplates, featuredfeed, feedcontributions, feedrecentchanges, feedwatchlist, filerevert, flagconfig, globalblock, globalpreferenceoverrides, globalpreferences, globaluserrights, growthmanagementorlist, growthmentordashboardupdatedata, growthsetmenteestatus, growthsetmentor, growthstarmentee, help, homepagequestionstore, imagerotate, import, jsonconfig, languagesearch, linkaccount, login, logout, managetags, massmessage, mergehistory, move, opensearch, options, paraminfo, parse, patrol, protect, purge, query, removeauthenticationdata, resetpassword, review, revisiondelete, rollback, rsd, setglobalaccountstatus, setnotificationtimestamp, setpagelanguage, shortenurl, sitematrix, spamblacklist, stabilize, streamconfigs, strikevote, sxdelete, tag, templatedata, thank, titleblacklist, torblock, transcodereset, unblock, undelete, unlinkaccount, upload, userrights, validatepassword, watch, webapp-manifest, webauthn, bouncehandler, categorytree, cirrus-check-sanity, collection, cspreport, cxcheckunreviewed, cxpublish, cxpublishsection, cxsave, cxsplit, discussiontoolscompare, discussiontoolspageinfo, discussiontoolspreview, echopushsubscriptions, editcheckreferenceurl, fancycaptchareload, growthinvalidateimagerecommendation, growthinvalidatepersonalizedpraisesuggestion, helppanelquestionposter, jsondata, oathvalidate, parser-migration, readinglists, sanitize-mapdata, scribunto-console, securepollauth, stashedit, sxsave, timedtext, ulslocalization, ulssetlang, visualeditor, visualeditoredit, wikimediaeventsblockededit

Standard: help

format

Format der Ausgabe.

json

Daten im JSON-Format ausgeben.

jsonfm

Daten im JSON-Format ausgeben (schöngedruckt in HTML).

none

Nichts ausgeben.

php

Daten im serialisierten PHP-Format ausgeben.

phpfm

Daten im serialisierten PHP-Format ausgeben (schöngedruckt in HTML).

rawfm

Daten, einschließlich Fehlerbehebungselementen, im JSON-Format ausgeben (schöngedruckt in HTML).

xml

Daten im XML-Format ausgeben.

xmlfm

Daten im XML-Format ausgeben (schöngedruckt in HTML).

Einer der folgenden Werte: json, jsonfm, none, php, phpfm, rawfm, xml, xmlfm

Standard: jsonfm

maxlag

maxlag kann verwendet werden, wenn MediaWiki auf einem datenbankreplizierten Cluster installiert ist. Um weitere Replikationsrückstände zu verhindern, lässt dieser Parameter den Client warten, bis der Replikationsrückstand kleiner als der angegebene Wert (in Sekunden) ist. Bei einem größerem Rückstand wird der Fehlercode maxlag zurückgegeben mit einer Nachricht wie Waiting for host:host: host:lag seconds lagged.
Siehe Handbuch: Maxlag parameter für weitere Informationen.

Typ: Ganzzahl

smaxage

Den s-maxage-HTTP-Cache-Control-Header auf diese Anzahl Sekunden festlegen. Fehler werden niemals gepuffert.

Typ: Ganzzahl

Der Wert darf nicht kleiner sein als 0.

Standard: 0

maxage

Den max-age-HTTP-Cache-Control-Header auf diese Anzahl Sekunden festlegen. Fehler werden niemals gecacht.

Typ: Ganzzahl

Der Wert darf nicht kleiner sein als 0.

Standard: 0

assert

Sicherstellen, dass der Benutzer eingeloggt ist (eventuell auch als temporärer Benutzer), wenn user gesetzt, nicht angemeldet, wenn auf anon gesetzt, oder das Bot-Benutzerrecht hat, wenn auf bot gesetzt.

Einer der folgenden Werte: anon, bot, user

assertuser

Überprüft, ob der aktuelle Benutzer der benannte Benutzer ist.

Typ: Benutzer, von einem der Benutzername und Vorläufiger Benutzer

requestid

Der angegebene Wert wird mit in die Antwort aufgenommen und kann zur Unterscheidung von Anfragen verwendet werden.

servedby

Namen des bearbeitenden Hosts mit zurückgeben.

Type: boolean (details)

curtimestamp

Aktuellen Zeitstempel mit zurückgeben.

Type: boolean (details)

responselanginfo

Bezieht die für uselang und errorlang verwendeten Sprachen im Ergebnis mit ein.

Type: boolean (details)

origin

Beim Zugriff auf die API mit einer Kreuz-Domain-AJAX-Anfrage (CORS) muss dies als entstehende Domäne festgelegt werden. Dies muss in jeder Vorfluganfrage mit eingeschlossen werden und deshalb ein Teil der Anfragen-URI sein (nicht des POST-Körpers).

Für authentifizierte Anfragen muss dies exakt einem der Ursprünge im Header Origin entsprechen, so dass es auf etwas wie https://de.wikipedia.org oder https://meta.wikimedia.org festgelegt werden muss. Falls dieser Parameter nicht mit dem Header Origin übereinstimmt, wird eine 403-Antwort zurückgegeben. Falls dieser Parameter mit dem Header Origin übereinstimmt und der Ursprung erlaubt ist, werden die Header Access-Control-Allow-Origin und Access-Control-Allow-Credentials festgelegt.

Gib für nicht authentifizierte Anfragen den Wert * an. Dies verursacht, dass der Header Access-Control-Allow-Origin festgelegt wird, aber Access-Control-Allow-Credentials wird false sein und alle benutzerspezifischen Daten werden beschränkt.

uselang

Zu verwendende Sprache für Nachrichtenübersetzungen. action=query&meta=siteinfo&siprop=languages gibt eine Liste der Sprachcodes zurück. Gib user zum Verwenden der aktuellen Benutzerspracheinstellung oder content an, um die Inhaltssprache des Wikis zu verwenden.

Standard: user

variant

Variante der Sprache. Funktioniert nur, wenn die Basissprache die Variantenkonvertierung unterstützt.

errorformat

Zu verwendendes Format zur Ausgabe von Warnungen und Fehlertexten

plaintext

Wikitext mit entfernten HTML-Tags und ersetzten Entitäten.

wikitext

Ungeparster Wikitext.

html

HTML

raw

Nachrichtenschlüssel und Parameter.

none

Keine Textausgabe, nur die Fehlercodes.

bc

Format, das vor MediaWiki 1.29 verwendet wurde. errorlang und erroruselocal werden ignoriert.

Einer der folgenden Werte: bc, html, none, plaintext, raw, wikitext

Standard: bc

errorlang

Zu verwendende Sprache für Warnungen und Fehlermeldungen. action=query&meta=siteinfo&siprop=languages mit siprop=languages gibt eine Liste von Sprachcodes zurück. Spezifiziere content, um die Inhaltssprache des Wikis zu verwenden, oder uselang, um denselben Wert wie der uselang-Parameter zu verwenden.

Standard: uselang

errorsuselocal

Falls angegeben, verwenden Fehlertexte lokalisierte Nachrichten aus dem MediaWiki-Namensraum.

Type: boolean (details)

centralauthtoken

Wenn du mit einer domänenübergreifenden AJAX-Anfrage (CORS) auf die API zugreifst, verwendest du dies, um dich als der aktuelle SUL-Benutzer zu authentifizieren. Verwende action=centralauthtoken in diesem Wiki, um das Token abzurufen, bevor du die CORS-Anfrage stellst. Jedes Token darf nur einmal verwendet werden und verfällt nach 10 Sekunden. Dies sollte in jeder Pre-Flight-Anfrage enthalten sein und daher in der Anfrage-URI (nicht im POST-Body) enthalten sein.

Berechtigung:

apihighlimits

Höhere Beschränkungen in API-Anfragen verwenden (langsame Anfragen: 500; schnelle Anfragen: 5000). Die Beschränkungen für langsame Anfragen werden auch auf Mehrwertparameter angewandt.

Gewährt an: bot und sysop

Datentypen

Input to MediaWiki should be NFC-normalized UTF-8. MediaWiki may attempt to convert other input, but this may cause some operations (such as edits with MD5 checks) to fail.

Parameters that take multiple values are normally submitted with the values separated using the pipe character, e.g. param=value1|value2 or param=value1%7Cvalue2. If a value must contain the pipe character, use U+001F (Unit Separator) as the separator and prefix the value with U+001F, e.g. param=%1Fvalue1%1Fvalue2.

Some parameter types in API requests need further explanation:

boolean

Boolean parameters work like HTML checkboxes: if the parameter is specified, regardless of value, it is considered true. For a false value, omit the parameter entirely.

expiry

Ablaufwerte können relativ (z. B. 5 months oder 2 weeks) oder absolut (z. B. 2014-09-18T12:34:56Z) sein. Verwende für kein Ablaufdatum infinite, indefinity, infinity oder never.

timestamp

Timestamps may be specified in several formats, see the Timestamp library input formats documented on mediawiki.org for details. ISO 8601 date and time is recommended: 2001-01-15T14:56:00Z. Additionally, the string now may be used to specify the current timestamp.

Vorlagenparameter

Templated parameters support cases where an API module needs a value for each value of some other parameter. For example, if there were an API module to request fruit, it might have a parameter fruits to specify which fruits are being requested and a templated parameter {fruit}-quantity to specify how many of each fruit to request. An API client that wants 1 apple, 5 bananas, and 20 strawberries could then make a request like fruits=apples|bananas|strawberries&apples-quantity=1&bananas-quantity=5&strawberries-quantity=20.

Danksagungen

API-Entwickler:

Bitte sende deine Kommentare, Vorschläge und Fragen an mediawiki-api@lists.wikimedia.org oder reiche einen Fehlerbericht auf https://phabricator.wikimedia.org/ ein.