API:Eigenschaften

From mediawiki.org
This page is a translated version of the page API:Properties and the translation is 100% complete.

GET-Abfrage, um Eigenschaften ausgewählter Seiten zu erhalten.

API-Dokumentation

Eigenschaften sind Daten über eine Seite, wie Kategorien oder der Inhalt einer Seite, beispielsweise Bilder oder Links. Um eine Eigenschaft abzufragen, gib für den Parameter prop deiner Abfrage ein gültiges Eigenschafts-Submodul an, das der Information entspricht, die du benötigst.

Die Seite oder Seiten, deren Daten du abfragst, werden über einen der Parameter titles, pageids oder revids der Abfrage oder über einen Generator angegeben.

Abfragen für Eigenschaften werden wie folgt geschrieben: action=query&titles=title1&prop=property1|property2.

Eigenschaften-Abfragen haben immer ein Limit für die Anzahl der Objekte, die ausgegeben werden. Um mehr Objekte zu sehen, hänge die Werte innerhalb des continue -Elements der Ergebnisse der ursprünglichen Abfrage an.

Siehe bitte die individuellen Eigenschaften-API-Seiten für genauere Beispiele zur Nutzung von Eigenschaften:

Zusätzliche Anmerkungen

  • Die meisten Eigenschaften-Submodule können als Generatoren genutzt werden, sofern nichts anderes angegeben ist.
  • Limits für Eigenschafts-Abfragen:
    • Ergebnisse für Eigenschafts-Abfragen haben immer ein Limit; das Standardlimit ist 10. Das Ergebnislimit kann für normale Benutzer auf bis zu 500 gesetzt werden oder auf 5000 für Benutzer mit dem apihighlimits-Recht (typischerweise Bots und Admins). Einige Module verhängen unter bestimmten Bedingungen striktere Limits.
    • Wenn du nicht sicher bist, welches Limit für dich gilt und du so viele Ergebnisse wie möglich erhalten willst, dann setze das Limit auf max. In diesem Fall wird ein limits-Element zurückgegeben, das die verwendeten Limits spezifiziert.
    • Der Limit-Parameter für ein gegebenes Modul besteht aus dem Modul-Präfix gefolgt von dem Wort limit. Zum Beispiel wird bei imlimit die maximale Anzahl von images ausgegeben.

Siehe auch

  • Dokumentation im Abfragemodul - enthält eine kurze Beschreibung aller Eigenschaften-Submodule, der entsprechenden Parameter und Werte.
  • API:Datenbankfeld und API-Eigenschaftszuordnung - enthält eine Tabelle, die beschreibt, wie Abfrage-Eigenschaften mit den Feldern in einer MediaWiki-Datenbank verbunden sind.
  • API:Listen - eine ähnliche API für den Zugriff auf Listen von Informationen, wie allusers oder recentchanges. Im Gegensatz zu Eigenschaften-Abfragen, die Daten an das pages-Element anhängen, geben Listen eine eigene Verzweigung in dem query-Element aus.