Ask-API

From semantic-mediawiki.org
Jump to: navigation, search

Die Programmschnittstelle Ask-API ermöglicht es, unter Zuhilfenahme der MediaWiki API (en), eingebettete Abfragen auszuführen und die entsprechenden Ergebnisse serialisiert, in einem der unterstützten Formate, ausgegeben zu bekommen. Es sind zwei API-Module verfügbar, die sich darin unterscheiden, wie die Abfrage angegeben werden muss. Indes ist die Ausgabe der Abfrageergebnisse jeweils identisch.

Ask

Das Modul „Ask“ unterstützt Abfragen mit einem Parameter. Dabei wird die selbe Zeichenkette jeweils im URL-kodiertem Format an die Parserfunktion #ask weitergegeben.

Beispiel
api.php?action=ask&query=[[Zuletzt ge%E4ndert::%2B]]|%3FZuletzt ge%E4ndert|sort%3DZuletzt ge%E4ndert|order%3Ddesc&format=jsonfm
Beispiel ausführen

Die entsprechende eingebettete Abfrage sähe wie folgt aus:

{{#ask: [[Zuletzt geändert::+]]
| ?Zuletzt geändert
| sort=Zuletzt geändert
| order=desc
| format=json
}}

Askargs

Das Modul „Askargs“ zielt darauf die Argumente in einer nicht serialisierten Form, unter Nutzung von so wenig Abfragesyntax als möglich, aufzunehmen. Es werden insgesamt drei Argumente von diesem Modul unterstützt:

  1. „conditions“: Die für die Seitenauswahl notwendigen Bedingungen.
  2. „printouts“: Die für die Ergebnisausgabe notwendigen Bedingungen, d. h. die anzuzeigenden Attributwerte.
  3. „parameters“: Die für die Ergebnisanzeige notwendigen Bedingungen sowie Ausgabeformate, d. h. die zu nutzenden Formatierungs- und Ausgabeoptionen.
Beispiel
api.php?action=askargs&conditions=Zuletzt ge%E4ndert::%2B&printouts=Modification date&parameters=|sort%3DZuletzt ge%E4ndert|order%3Ddesc&format=jsonfm
Beispiel ausführen

Die entsprechende eingebettete Abfrage sähe wie folgt aus:

{{#ask: [[Zuletzt geändert::+]]
| ?Zuletzt geändert
| sort=Zuletzt geändert
| order=desc
| format=json
}}

Dokumente

Siehe auch



Diese Dokumentationsseite gilt für alle SMW-Versionen von 1.7.0 bis zur aktuellsten Version.
      Andere Sprachen: en

Ask API de 1.7.0