MediaWiki-API-Hilfe
Dies ist eine automatisch generierte MediaWiki-API-Dokumentationsseite.
Dokumentation und Beispiele: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page
Hauptmodul
- Quelle: MediaWiki
- Lizenz: GPL-2.0-or-later
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.
- action
Auszuführende Aktion.
- ask
- API-Modul zum Abfragen eines Wikis mit der Abfragesprache von Semantic MediaWiki.
- askargs
- API-Modul zum Abfragen eines Wikis mit der Abfragesprache von Semantic MediaWiki als Liste von Bedingungen, Ausgabeanweisungen und Parametern.
- block
- Sperrt einen Benutzer.
- bs-adminuser-store
- Listet alle in der Datenbank vorhandenen Benutzer mitsamt vertraulicher Daten auf. Erlaubt Sortierung, Filterung und seitenweise Anzeige. Implementiert „ExtJS-Store“-Parameter.
- bs-avatars-tasks
- Hochladen, Erstellen und Festlegen von Benutzerbildern
- bs-book-chapters-store
- Ermöglicht die Abfrage aller Bücher und ihrer Kapitelseiten.
- bs-books-overview-store
- Listet alle Bücher auf, einschließlich Bücherregal, Link zum ersten Kapitel und Aktionen.
- bs-bookshelf-bookstore
- Listet alle Kapitel für ein gegebenes Buch auf. Ermöglicht Sortieren, Filtern und Seitennummerierung. Implementiert „ExtJS Store“-Parameter.
- bs-bookshelf-manage
- Bietet Aufgaben für die Buchmanipulation.
- bs-bookshelf-mass-add-page-store
- Stellt Seiten bereit, die zusammen zu einem Buch hinzugefügt werden können.
- bs-bookshelf-page-collection-store
- Stellt eine Sammlung von Seiten bereit, die zusammen zu einem Buch hinzugefügt werden können.
- bs-bookshelf-store
- Listet alle Bücher auf. Ermöglicht Sortieren, Filtern und Seitennummerierung. Implementiert „ExtJS Store“-Parameter.
- bs-category-store
- Listet alle Kategorien auf. Erlaubt die Sortierung, Filterung und Seitennummerierung. Implementiert die Parameter „ExtJS Store“.
- bs-category-treestore
- Listet die Unterkategorien einer bestimmten Kategorie auf
- bs-categorylinks-store
- Listet alle Kategorien einer Seite inklusive eines Links zur Kategorienseite und einer Markierung für explizite und implizite Kategorien auf.
- bs-checklist-available-options-store
- Listet alle verfügbaren Optionen für Prüflistenvorlagen auf. Erlaubt die Sortierung, Filterung und Nummerierung. Implementiert ExtJS-Store-Parameter.
- bs-checklist-tasks
- Bietet Operationen für die Prüflistenerweiterung
- bs-checklist-template-store
- Listet alle Vorlagen auf, die gültige Prüflistenquellen sind. Erlaubt die Sortierung, Filterung und Nummerierung. Implementiert ExtJS-Store-Parameter.
- bs-configmanager-store
- Verwaltet Speicher
- bs-configmanager-tasks
- Verwaltet Aufgaben
- bs-contextmenu-tasks
- Stellt die Kontextmenüeinträge im Kontext zur Verfügung
- bs-dashboards-store
- Listet alle verfügbaren Portlets auf
- bs-dashboards-tasks
- Speichert die Dashboard-Konfiguration
- bs-dashboards-widgets-tasks
- Gibt den Inhalt für einige Dashboard-Widgets zurück
- bs-expiry-store
- Stellt einen Suchspeicher für Veraltungen bereit, die abgefragt werden können
- bs-expiry-tasks
- Stellt Aufgaben wie das Bearbeiten oder Löschen von Veraltungen bereit
- bs-extendedsearch-autocomplete
- Gibt die Ergebnisse der Autovervollständigung für eine gegebene Anfrage zurück
- bs-extendedsearch-query
- Suche im Index
- bs-extendedsearch-resultrelevance
- Gibt die Relevanz der Suchergebnisse zurück
- bs-extendedsearch-stats
- Liefert statistische Daten über die registrierten Backends und deren konfigurierte Quellen.
- bs-extendedsearch-triggerupdate
- Aktualisierung des Suchindex auslösen
- bs-extendedsearch-type-store
- Gibt die registrierten Suchtypen zurück
- bs-file-tasks
- bs-filebackend-store
- Listet alle gespeicherten Dateien auf. Erlaubt Sortierung, Filterung und seitenweise Anzeige. Implementiert „ExtJS-Store“-Parameter.
- bs-filehistory-store
- bs-group-store
- Listet alle Benutzergruppen, mit Ausnahme der mit Konfigurationsparameter
$wgImplicitGroups
festgelegten, auf. Erlaubt Sortierung, Filterung und seitenweise Anzeige. Implementiert „ExtJS-Store“-Parameter. - bs-groupmanager
- Bietet die Aufgaben für die Erweiterung „GroupManager“.
- bs-insertfile-license-store
- Listet die Lizenzen für die Erweiterung „InsertFile“ auf.
- bs-inserttemplate-store
- Listet alle Vorlagen auf. Erlaubt die Sortierung, Filterung und Seitennummerierung. Implementiert die Parameter „ExtJS Store“.
- bs-interwiki-store
- Listet alle Interwikilinks auf. Erlaubt Sortierung, Filterung und seitenweise Anzeige. Implementiert „ExtJS-Store“-Parameter.
- bs-interwikilinks-tasks
- Stellt die Aufgaben für die Erweiterung „InterWikiLinks“ bereit.
- bs-js-var-config
- Stellt einen API Endpunkt zur Verfügung, über den man clientseitige Konfigurationsvariablen abfragen kann
- bs-linker
- Gibt Links zu Seiten zurück, die von Linker erzeugt wurden
- bs-mypageassignment-store
- Gibt Seiten zurück, die dem aktuellen Benutzer zugewiesen sind.
- bs-namespace-store
- Listet alle Namensräume und deren zusätzliche Konfiguration auf. Erlaubt Sortierung, Filterung und seitenweise Anzeige. Implementiert ExtJS Store Parameter.
- bs-namespace-tasks
- Erlaubt die Veränderung der Namensraumkonfiguration.
- bs-nsfilerepo-connector
- API-Endpunkt für die Erweiterung BlueSpiceNSFileRepoConnector
- bs-nsfrc-tasks
- API-Endpunkt für die Erweiterung BlueSpiceNSFileRepoConnector
- bs-pageaccess-store
- Regelt den Zugriff auf Seitenebene
- bs-pageassignable-store
- Gibt die Liste der Zugewiesenen zurück
- bs-pageassignment-store
- Gibt Zuweisungen für die angegebene Seite zurück
- bs-pageassignment-tasks
- Ruft die Liste der Zuweisungen für eine angegebene Seite ab oder bearbeitet sie
- bs-pageauthors-store
- Listet alle Autoren einer gegebenen Seite im Kontext auf
- bs-pagetemplate-tags-store
- Listet alle Tags der Seitenvorlagen auf. Ermöglicht Sortierung, Filterung und Paginierung. Implementiert ExtJS Store-Parameter.
- bs-pagetemplates-store
- Listet alle Vorlagen auf. Erlaubt die Sortierung, Filterung und Seitennummerierung. Implementiert die Parameter „ExtJS Store“.
- bs-pagetemplates-tasks
- Erlaubt die Veränderung von Seitenvorlagen
- bs-permissionmanager-tasks
- Stellt die Aufgaben für die Erweiterung „PermissionManager“ bereit.
- bs-ping-tasks
- Ping-Aufgabe, die den kontinuierlichen Austausch von Daten ermöglicht.
- bs-privacy
- Endpunkt für alle API-Aktionen zum Thema Datenschutz
- bs-privacy-get-all-consents
- Endpunkt für das Erhalten von Einwilligungsinformationen für alle Benutzer
- bs-privacy-get-requests
- Endpunkt für das Abrufen aller ausstehenden Anfragen
- bs-qr-code
- QR Code als base64 data URI für eine Seite
- bs-rating-tasks
- Führt allgemeine Aufgaben für die Erweiterung Rating durch
- bs-ratingarticle-store
- Liefert Bewertungen für Artikel
- bs-ratingarticlelike-store
- Liefert Empfehlungen für Artikel
- bs-readconfirmation-tasks
- API-Endpunkt für die Erweiterung Lesebestätigung
- bs-readers-data-store
- Ruft Leserinformationen einer angegebenen Seite ab.
- bs-readers-page-readers-store
- Ruft alle Leser aller Seiten ab
- bs-readers-revision-readers-store
- Ruft alle Leser aller Versionen eines Artikels ab
- bs-readers-tasks
- Ermöglicht häufig vorkommende Arbeitsvorgänge für Leser
- bs-readers-users-store
- Ruft alle Leserinformationen einer angegebenen Seite ab.
- bs-recentchanges-store
- Listet alle Letzten Änderungen auf. Erlaubt die Sortierung, Filterung und seitenweise Anzeige. Implementiert „Store“-Parameter.
- bs-reminder-store
- Stellt einen Suchspeicher für Erinnerungen bereit, die abgefragt werden können
- bs-reminder-tasks
- Stellt Aufgaben wie das Bearbeiten oder Löschen von Erinnerungen bereit
- bs-role-permission-store
- Stellt eine Rollenbeschreibung für den PermissionManager zur Verfügung
- bs-rss-standards-pages-store
- Gibt eine Liste mit verfügbaren Seiten für RSSFeeder zurück
- bs-rssfeeder-tasks
- Stellt allgemeine Aufgaben für den RSSFeeder bereit
- bs-smartlist-tasks
- API-Funktionen zum Bereitstellen von Portletdaten für Seiten- und Benutzerstatistiken
- bs-smw-connector-ask-store
- ExtJS-kompatibler Datenspeicher für die Ausführung semantischer Abfragen
- bs-smw-connector-smw-property-store
- ExtJS-kompatibler Speicher zum Abrufen von Eigenschaftswerten
- bs-smw-connector-tree-ask-store
- ExtJS-kompatibler Baumspeicher zum Ausführen semantischer Abfragen
- bs-social-tasks
- Stellt Aufgaben wie das Bearbeiten oder Löschen von Entitäten bereit
- bs-socialentity-store
- Stellt einen Suchspeicher für Entitäten bereit, die abgefragt werden können
- bs-socialresolve-tasks
- Stellt Aufgaben für die Bearbeitung des Erledigt-Status von Entitäten bereit
- bs-socialtags-tasks
- Stellt Aufgaben für die Bearbeitung verlinkter Seiten von Entities bereit
- bs-socialtitlequery-store
- Stellt Daten für Titel bereit, die von einer Entität verlinkt werden können
- bs-socialtopics-tasks
- Stellt Funktionen wie die automatische Einrichtung einer Diskussionsseite bereit
- bs-socialwatch-tasks
- Stellt Aufgaben für die Bearbeitung des Beobachten-Status von Entitäten bereit
- bs-statistics-available-diagrams-store
- Bietet einen Speicher mit verfügbaren Diagrammen
- bs-statistics-search-options-store
- Stellt einen Speicher mit verfügbaren Suchoptionen zur Verfügung
- bs-statistics-tasks
- Stellt allgemeine Aufgaben für Statistiken bereit
- bs-task
- Stellt den API-Endpunkt zur Ausführung registrierter Aufgaben bereit
- bs-templatelinks-store
- Listet alle Vorlagen einer Seite inklusive eines Links zur Vorlage.
- bs-titlequery-store
- Listet Seitentitel und wahlweise Namensraumpräfixe entsprechend einem Abfragebegriff auf. Implementiert „ExtJS-Store“-Parameter.
- bs-translation-transfer-foreign-page-tasks
- bs-translation-transfer-tasks
- bs-upload-license-store
- Listet alle verfügbaren Lizenzen für einen Dateiupload auf
- bs-usagetracker-store
- Enthält statistische Daten zur Verwendung von Erweiterungen
- bs-user-store
- Listet alle in der Datenbank vorhandenen Benutzer auf. Erlaubt Sortierung, Filterung und seitenweise Anzeige. Implementiert „ExtJS-Store“-Parameter.
- bs-userinfometa
- Listet die Metadaten eines bestimmten Benutzers auf
- bs-usermanager-group-store
- Stellt die UserManager-Aufgaben-API für BlueSpice bereit.
- bs-usermanager-tasks
- Bietet Operationen für die Prüflistenerweiterung
- bs-watchlist-store
- Listet alle Beobachtungslisteneinträge auf. Erlaubt die Sortierung, Filterung und Nummerierung. Implementiert Speicherparameter.
- bs-wikiexplorer-store
- Stellt alle Daten für die Erweiterung WikiExplorer bereit
- bs-wikipage-store
- Listet alle Wikiseiten auf. Erlaubt Sortierung, Filterung und seitenweise Anzeige. Implementiert „ExtJS-Store“-Parameter.
- bs-wikipage-tasks
- Ermöglicht häufig vorkommende Arbeitsvorgänge für Wikiseiten
- bs-wikisubpage-treestore
- Listet die Unterseiten einer bestimmten Wikiseite auf
- 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.
- 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.
- compare
- Ruft den Unterschied zwischen zwei Seiten ab.
- compoundquery
- content-transfer-do-push-single
- Überträgt eine einzelne Seite an ein Empfänger-Wiki
- content-transfer-get-pages
- Listet alle Seiten auf, die basierend auf gegebenen Filtern pushbar sind
- content-transfer-purge-pages
- Bereinigt alle Seiten, die an das empfangende Wiki übertragen wurden
- content-transfer-push-info
- Ruft alle Ressourcen wie eingebundene Dateien, verlinkte Seiten usw. der Seite ab, die in ein Ziel-Wiki übertragen werden sollen
- cpd-delete-orphaned-elements
- Löscht Elemente des BPMN-Diagramms, welche entfernt wurden
- cpd-save-diagram-elements
- Speichert Elemente des BPMN-Diagramms als Wiki-Seiten oder aktualisiert diese, wenn sie schon existieren
- createaccount
- Erstellt ein neues Benutzerkonto.
- delete
- Löscht eine Seite.
- edit
- Erstellen und Bearbeiten von Seiten.
- emailuser
- E-Mail an einen Benutzer senden.
- embedvideo
- Ermittelt den generierten Videoeinbettungscode für die angegebenen Parameter.
- expandtemplates
- Alle Vorlagen innerhalb des Wikitextes expandieren.
- ext.srf.datatables.api
- ext.srf.slideshow.show
- 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.
- flexiskin-activation
- Das Aktivierungsmodul
- flexiskin-delete
- Das Löschmodul
- flexiskin-preview
- Das Vorschau-Modul
- flexiskin-save
- Das Speichermodul
- forms-form-submit
- Bietet Bearbeitung über Formulare
- forms-get-definitions
- Ermöglicht die Abfrage der vorhandenen Formulardefinitionen
- getheaderfooter
- Retrieve the parsed output of a header or footer in the context of a certain page.
- help
- Hilfe für die angegebenen Module anzeigen.
- imagerotate
- Ein oder mehrere Bilder drehen.
- import
- Importiert eine Seite aus einem anderen Wiki oder von einer XML-Datei.
- linkaccount
- Verbindet ein Benutzerkonto von einem Drittanbieter mit dem aktuellen Benutzer.
- login
- Anmelden und Authentifizierungs-Cookies beziehen.
- logout
- Abmelden und alle Sitzungsdaten löschen.
- ma-discard-draft
- Discard existing draft version of a page
- ma-merge-page-existing
- Merges a draft version into an existing page
- ma-merge-page-new
- Merges a draft version into a new page
- ma-set-related-titles
- Relates a page to a draft version of the page
- managetags
- Ermöglicht Verwaltungsaufgaben zu Änderungsmarkierungen.
- 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.
- pagecheckout-clear
- Aktiven Seiten-Checkout aufheben
- paraminfo
- Ruft Informationen über API-Module ab.
- parse
- Parst den Inhalt und gibt die Parserausgabe zurück.
- patrol
- Kontrolliert eine Seite oder Version.
- pfautocomplete
- Von der Softwareerweiterung „Page Forms“ genutzte Autovervollständigung.
- pfautoedit
- Erstellt oder bearbeitet eine Seite mit einem Formular, das mit Hilfe der Softwareerweiterung „Page Forms“ definiert wird.
- 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.
- 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.
- setnotificationtimestamp
- Update the notification timestamp for watched pages.
- setpagelanguage
- Ändert die Sprache einer Seite.
- smwbrowse
- API-Modul zur Unterstützung von Aktivitäten beim Browsen für unterschiedliche Objekttypen in Semantic MediaWiki.
- smwinfo
- API-Modul zum Abrufen statistischer Daten und weiterer Metainformationen bezüglich der Nutzung von Semantic MediaWiki.
- smwtask
- API-Modul zum Ausführen Semantic MediaWiki betreffender Aufgaben, das nur von der Software selbst und nicht von Außen genutzt wird.
- streamconfigs
- Zeigt die Konfiguration des Ereignisstroms an. Gibt nur format=json mit formatversion=2 zurück.
- tag
- Add or remove change tags from individual revisions or log entries.
- templatedata
- Ruft Daten ab, die durch die Erweiterung „TemplateData“ gespeichert werden.
- 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.
- webauthn
- API-Modul zur Kommunikation zwischen Server und Client während des Registrierungs-Authentifizierungsprozesses
- browsebyproperty
- Veraltet. API-Modul zum Abrufen von Informationen zu einem Attribut oder einer Liste von Attributen.
- browsebysubject
- Veraltet. API-Modul zum Abrufen von Informationen zu einem Objekt (Seite oder Unterobjekt).
- bs-translation-transfer-convert
- Intern.
- categorytree
- Intern. Internes Modul für die Erweiterung „CategoryTree“.
- 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.
- oathvalidate
- Intern. Überprüft einen Token zur Zwei-Faktor-Authentifizierung (OATH).
- scribunto-console
- Intern. Internes Modul zur Verarbeitung von XHR-Anfragen der Scribunto-Konsole.
- stashedit
- Intern. Prepare an edit in shared cache.
- 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).
- Einer der folgenden Werte: ask, askargs, block, bs-adminuser-store, bs-avatars-tasks, bs-book-chapters-store, bs-books-overview-store, bs-bookshelf-bookstore, bs-bookshelf-manage, bs-bookshelf-mass-add-page-store, bs-bookshelf-page-collection-store, bs-bookshelf-store, bs-category-store, bs-category-treestore, bs-categorylinks-store, bs-checklist-available-options-store, bs-checklist-tasks, bs-checklist-template-store, bs-configmanager-store, bs-configmanager-tasks, bs-contextmenu-tasks, bs-dashboards-store, bs-dashboards-tasks, bs-dashboards-widgets-tasks, bs-expiry-store, bs-expiry-tasks, bs-extendedsearch-autocomplete, bs-extendedsearch-query, bs-extendedsearch-resultrelevance, bs-extendedsearch-stats, bs-extendedsearch-triggerupdate, bs-extendedsearch-type-store, bs-file-tasks, bs-filebackend-store, bs-filehistory-store, bs-group-store, bs-groupmanager, bs-insertfile-license-store, bs-inserttemplate-store, bs-interwiki-store, bs-interwikilinks-tasks, bs-js-var-config, bs-linker, bs-mypageassignment-store, bs-namespace-store, bs-namespace-tasks, bs-nsfilerepo-connector, bs-nsfrc-tasks, bs-pageaccess-store, bs-pageassignable-store, bs-pageassignment-store, bs-pageassignment-tasks, bs-pageauthors-store, bs-pagetemplate-tags-store, bs-pagetemplates-store, bs-pagetemplates-tasks, bs-permissionmanager-tasks, bs-ping-tasks, bs-privacy-get-all-consents, bs-privacy-get-requests, bs-privacy, bs-qr-code, bs-rating-tasks, bs-ratingarticle-store, bs-ratingarticlelike-store, bs-readconfirmation-tasks, bs-readers-data-store, bs-readers-page-readers-store, bs-readers-revision-readers-store, bs-readers-tasks, bs-readers-users-store, bs-recentchanges-store, bs-reminder-store, bs-reminder-tasks, bs-role-permission-store, bs-rss-standards-pages-store, bs-rssfeeder-tasks, bs-smartlist-tasks, bs-smw-connector-ask-store, bs-smw-connector-smw-property-store, bs-smw-connector-tree-ask-store, bs-social-tasks, bs-socialentity-store, bs-socialresolve-tasks, bs-socialtags-tasks, bs-socialtitlequery-store, bs-socialtopics-tasks, bs-socialwatch-tasks, bs-statistics-available-diagrams-store, bs-statistics-search-options-store, bs-statistics-tasks, bs-task, bs-templatelinks-store, bs-titlequery-store, bs-translation-transfer-foreign-page-tasks, bs-translation-transfer-tasks, bs-upload-license-store, bs-usagetracker-store, bs-user-store, bs-userinfometa, bs-usermanager-group-store, bs-usermanager-tasks, bs-watchlist-store, bs-wikiexplorer-store, bs-wikipage-store, bs-wikipage-tasks, bs-wikisubpage-treestore, changeauthenticationdata, changecontentmodel, checktoken, clearhasmsg, clientlogin, compare, compoundquery, content-transfer-do-push-single, content-transfer-get-pages, content-transfer-purge-pages, content-transfer-push-info, cpd-delete-orphaned-elements, cpd-save-diagram-elements, createaccount, delete, edit, emailuser, embedvideo, expandtemplates, ext.srf.datatables.api, ext.srf.slideshow.show, feedcontributions, feedrecentchanges, feedwatchlist, filerevert, flexiskin-activation, flexiskin-delete, flexiskin-preview, flexiskin-save, forms-form-submit, forms-get-definitions, getheaderfooter, help, imagerotate, import, linkaccount, login, logout, ma-discard-draft, ma-merge-page-existing, ma-merge-page-new, ma-set-related-titles, managetags, mergehistory, move, opensearch, options, pagecheckout-clear, paraminfo, parse, patrol, pfautocomplete, pfautoedit, protect, purge, query, removeauthenticationdata, resetpassword, revisiondelete, rollback, rsd, setnotificationtimestamp, setpagelanguage, smwbrowse, smwinfo, smwtask, streamconfigs, tag, templatedata, unblock, undelete, unlinkaccount, upload, userrights, validatepassword, watch, webauthn, browsebyproperty, browsebysubject, bs-translation-transfer-convert, categorytree, cspreport, oathvalidate, scribunto-console, stashedit, visualeditor, visualeditoredit
- 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: $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
- Standard: 0
- maxage
Den
max-age
-HTTP-Cache-Control-Header auf diese Anzahl Sekunden festlegen. Fehler werden niemals gecacht.- Typ: Ganzzahl
- Standard: 0
- assert
Sicherstellen, dass der Benutzer eingeloggt ist, 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 Benutzername
- 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 HeaderOrigin
übereinstimmt, wird eine 403-Antwort zurückgegeben. Falls dieser Parameter mit dem HeaderOrigin
übereinstimmt und der Ursprung erlaubt ist, werden die HeaderAccess-Control-Allow-Origin
undAccess-Control-Allow-Credentials
festgelegt.Gib für nicht authentifizierte Anfragen den Wert * an. Dies verursacht, dass der Header
Access-Control-Allow-Origin
festgelegt wird, aberAccess-Control-Allow-Credentials
wirdfalse
sein und alle benutzerspezifischen Daten werden beschränkt.- uselang
Zu verwendende Sprache für Nachrichtenübersetzungen. action=query&meta=siteinfo mit 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 Fehler. action=query&meta=siteinfo mit siprop=languages gibt eine Liste von Sprachcodes zurück, oder spezifiziere content, um die Inhaltssprache des Wikis zu verwenden, oder spezifiziere 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)
- Hilfe für das Hauptmodul
- api.php?action=help [in Spielwiese öffnen]
- Alle Hilfen in einer Seite
- api.php?action=help&recursivesubmodules=1 [in Spielwiese öffnen]
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:
- Yuri Astrakhan (Autor, Hauptentwickler von September 2006 bis September 2007)
- Roan Kattouw (Hauptentwickler von September 2007 bis September 2009)
- Victor Vasiliev
- Bryan Tong Minh
- Sam Reed
- Brad Jorsch (Hauptentwickler 2013-2020)
Bitte sende deine Kommentare, Vorschläge und Fragen an mediawiki-api@lists.wikimedia.org oder reiche einen Fehlerbericht auf https://phabricator.wikimedia.org/ ein.