Wikibase/API/de

Was ist die Wikibase-API?
Wikibase bietet einen allgemeinen Mechanismus zum Speichern von Anweisungen als strukturierte Daten. Die Aussagen über Datenobjekte befinden sich auf dem Server unter wikidata.org. Weitere Informationen zu Wikibase und anderen Konzepten findest Du unter Wikidata: Glossar.



Die Wikibase-API erlaubt es, Informationen in Wikidata oder jeder anderen Wikibase-Instanz abzufragen, hinzuzufügen, zu entfernen und zu bearbeiten.

Sie wird über eine Reihe von Erweiterungen der MediaWiki-API-Module angeboten. Um die Wikibase API zu nutzen, solltest du grundsätzlich mit der MediaWiki Action API vertraut sein: Aktionen, Abfragen, etc., sowie die generischen Parameter, wie  und.

Wie man die Wikibase-API nutzt
Sende Abfragen über HTTP an die API, genau wie bei der MediaWiki Action API. Siehe API:Anleitung#Wie man sie nutzt für Informationen dazu, wie man die MediaWiki Action API nutzt.

Abfrage-Format
Der Endpunkt für die API ist https://wikidata.org/w/api.php.

Füge den Action-Parameter, der der API sagt, welche Aktion ausgeführt werden soll, zur Abfrage-Zeichenkette hinzu. Zum Beispiel sagt  der API, dass die Daten für Wikibase-Einträge erhalten werden sollen. Nutze für Meta- und Eigenschafts-Submodule entsprechend  und.

Einige Parameter sind fast immer verfügbar. Wenn Parameter mehrere Werte annehmen können, wird der Plural verwendet. Es gibt folgende Parameter:

GET-Abfrage
Erklärung von jedem Teil der URL:


 * ist der Haupt-Endpunkt.
 * sagt der API, dass die Daten für Wikibase-Einträge erhalten werden sollen.
 * bedeutet, dass die Daten aus der englischsprachigen Wikipedia erhalten werden.
 * gibt den Titel der Seite an, von der Daten erhalten werden sollen.
 * gibt die Eigenschaften an, die von den Einträgen erhalten werden, in diesem Fall stellen die Beschreibungen der Einträge die Eigenschaft dar.
 * steht dafür, die Ergebnisse auf englischsprachige zu beschränken.
 * gibt JSON-Ausgabe vor, was das empfohlene Ausgabeformat ist.

Antwort
Die Antwort einer Anfrage enthält für gewöhnlich Folgendes:


 * Ein -Schlüssel mit einer booleschen Umwandlung in eine ganze Zahl, wenn die Abfrage erfolgreich ist. Wenn die ganze Zahl Null ist, können alle weiteren Werte falsch sein.
 * Ein -Schlüssel mit einem Objekt aus zwei oder optional drei Schlüsseln, ,   und  , wenn die Abfrage nicht erfolgreich ist.
 * Information über die Aktion. Die Information wird entweder über die oberste Ebene oder unter dem Datenobjekt übergeben, wenn es sich um ein einziges Datenobjekt handelt oder unter den Datenobjekten, wenn es mehrere sind. Wenn es mehrere Datenobjekt sind, findet sich jedes unter einem Schlüssel mit eigener Datenobjekt-ID.

Leere Objekte werden als JSON-Arrays ausgegeben und nicht als Objekte, während leere Parameter den Eintrag aus dem Datenobjekt entfernen.

Meta-Submodule

 * wikibase: Gets information about the Wikibase client and the associated Wikibase repository.
 * wbcontentlanguages: Returns information about the content languages Wikibase accepts in different contexts.

Eigenschafts-Submodule

 * pageterms: Get the Wikidata terms (typically labels, descriptions and aliases) associated with a page via a sitelink.
 * wbentityusage: Returns all entity IDs used in the given pages.

API-Module

 * wbgetentities: Gets the data for multiple Wikibase entities.
 * wbavailablebadges: Queries available badge items.
 * wbcreateclaim: Creates Wikibase claims.
 * wbcreateredirect: Creates Entity redirects.
 * wbeditentity: Creates a single new Wikibase entity and modifies it with serialised information.
 * wbformatvalue: Formats DataValues.
 * wbgetclaims: Gets Wikibase claims.
 * wblinktitles: Associates two pages on two different wikis with a Wikibase item.
 * wbmergeitems: Merges multiple items.
 * wbparsevalue: Parses values using a ValueParser.
 * wbremoveclaims: Removes Wikibase claims.
 * wbremovequalifiers: Removes a qualifier from a claim.
 * wbremovereferences: Removes one or more references of the same statement.
 * wbsearchentities: Searches for entities using labels and aliases.
 * wbsetaliases: Sets the aliases for a Wikibase entity.
 * wbsetclaim: Creates or updates an entire Statement or Claim.
 * wbsetclaimvalue: Sets the value of a Wikibase claim.
 * wbsetdescription: Sets a description for a single Wikibase entity.
 * wbsetlabel: Sets a label for a single Wikibase entity.
 * wbsetqualifier: Creates a qualifier or sets the value of an existing one.
 * wbsetreference: Creates a reference or sets the value of an existing one.
 * wbsetsitelink: Associates a page on a wiki with a Wikibase item or removes an already made such association.
 * wbsgetsuggestions: Gets suggestions of additional properties to add to a Wikibase entity.
 * wbcheckconstraints: Performs constraint checks on any entity you want and returns the result.
 * wbcheckconstraintparameters: Checks the constraint parameters of constraint statements.

Mögliche Fehler
Mögliche Fehler für jedes Modul können durch Nutzung von  gefunden werden. Die Fehlerformate entsprechen denen der MediaWiki Action API. Siehe API:Fehler und Warnungen#Standard-Fehlermeldungen.

Alle Fehlermeldungen der Wikibase-Module sollten Internationalisiert (i18n) und lokalisiert (l10n) sein. Standard für Fehlermeldungen ist die festgelegte Sprache des angemeldeten Benutzers, dies kann jedoch durch Hinzufügen von  zur URL der Abfrage-Zeichenkette überschrieben werden.

Zusätzliche Anmerkungen

 * Auf vielen Wikimedia-Wikis läuft die Wikibase-Client-Erweiterung. Diese lässt API-Clients das -Meta-Submodul abfragen, um die URLs für das vollständige Wikibase-Repositorium zu bestimmen und das  -Eigenschafts-Submodul, um Informationen aus Wikidata über Seiten im lokalen Wiki zu erhalten.
 * Zusammen mit Wikibase können die Kalender-Module des Gregorianischen Kalenders (Q1985727) und des Julianischen Kalenders (Q1985786) genutzt werden.
 * Die API nutzt Versions-IDs, um Bearbeitungskonflikte zu erkennen. Wenn es einen Bearbeitungskonflikt gibt, muss der Abfragesteller sich eine neuere Versions-ID besorgen, um fortfahren zu können. Dies beinhaltet typischerweise,  für das fragliche Datenobjekt abzufragen und dann die Version des Eintrags zu speichern (und zu nutzen).
 * Jede MediaWiki-Installation kann Wikibase ausführen. Auf dem Wikimedia-Cluster können die meisten Wikis nicht alle Wikibase-Erweiterungen ausführen. Wikimedia Commons hat seine eigene Wikibase für Eigenschaften der Dateien auf Commons.
 * Teste nicht den -Wert für einen bestimmten Fehler, nutze stattdessen den  -Wert, da dieser unabhängig von der Lokalisierung bleibt.

Siehe auch

 * - Die Schnellstart-Anleitung für die MediaWiki Action API.
 * - Häufig gestellte Fragen über die MediaWiki Action API.
 * - Eine Anleitung zur Verwendung der MediaWiki Action API.
 * Lade Wikidata-Datenbank-Dumps in den Formaten JSON (empfohlen), XML und RDF herunter.