Help:Ergebnisformat json

From semantic-mediawiki.org
Jump to: navigation, search
Ergebnisformat json
Gibt die Ergebnisse im JSON-Format aus
Weitere Informationen
Software: Semantic MediaWiki
Verfügbar seit: 1.4.2
Verfügbar bis: aktuell unterstützt
Voraussetzungen: keine
Name: json
Standardmäßig aktiviert:
Gibt an, ob das Ergebnisformat standardmäßig mit Installation der betreffenden Softwareerweiterung aktiviert ist.
ja
Autoren: James Hong Kong, Fabian Howahl, Jeroen De Dauw
Kategorie(n): Export, Text
Inhaltsverzeichnis

Das Ergebnisformat json wird dazu eingesetzt Abfrageergebnisse (Spezial:Semantische Suche, eingebettete Abfragen) als Datei im JSON-Format exportieren zu können.

Mit SMW 1.8.0 wurde die Struktur der exportierten JSON-Daten verändert, um eine größere Validität des Codes zu erreichen. Dadurch wird eine bessere Serialisierung erreicht und zudem eine fehlerfreiere Weiternutzung möglich.

Parameter

Die folgenden Tabellen geben einen Überblick über die verfügbaren Parameter, beschreibt sie kurz und gibt deren Standardwerte mitsamt dem zugehörigen Eingabetyp an.

Allgemein

Parameter Typ Standard Beschreibung
source Text leer Die alternative Abfragequelle
limit Ganzzahl 100 Die maximale Anzahl der auszugebenden Ergebnisse
offset Ganzzahl 0 Das erste auszugebende Ergebnis
link Text all Die Ergebniswerte als Links anzeigen
sort Liste mit Texten leer Das Attribut nach dem die Abfrage sortiert werden soll
order Liste mit Texten leer Die Sortierreihenfolge für die Ergebnisse der Abfrage
headers Text show Die Überschriften/Attributnamen anzeigen
mainlabel Text no Die Bezeichnung für die Hauptergebnisspalte
intro Text leer Der vor etwaigen Abfrageergebnissen anzuzeigende Text
outro Text leer Der nach etwaigen Abfrageergebnissen anzuzeigende Text
searchlabel Text JSON Der Text zum Anzeigen weiterer Abfrageergebnisse
default Text leer Der anzuzeigende Text, sofern keine Abfrageergebnisse vorhanden sind

Format specific

Parameter Typ Standard Beschreibung
prettyprint ja/nein leer Die unformatierte Anzeige mit zusätzlichen Einzügen und neuen Zeilen

Beispiel

Standardausgabe

Hierbei ist der Ausgabeparameter automatisch mit „complete“ gesetzt.

{{#ask: [[Kategorie:Stadt]] [[liegt in::Deutschland]] 
| ?Bevölkerungszahl
| format=json
}}

Ergebnis: JSON

Struktur:

{
	"printrequests": [
		{
			"label": <Bezeichnung>,
			"typeid": <Kennzeichen>,
			"mode": <Modus>
		}
	],
	"results": {
		<Bezeichnung>: {
			"printouts": {
				<Merkmal>: [
					<Merkmalsausprägung>
				]
			},
			"fulltext": <Name>,
			"fullurl": <URL>
		}
	},
	"rows": <Anzahl>
}

Vereinfachte Ausgabe

Hierbei ist der Ausgabeparameter mit „basic“ gesetzt.

{{#ask: [[Kategorie:Stadt]] [[liegt in::Deutschland]] 
| ?Bevölkerungszahl
| format=json
| syntax=basic
}}

Ergebnis: JSON

Struktur:

{
	"printrequests": {
		<Merkmal>: {
			"label": <Bezeichnung>,
			"typeid": <Kennzeichen>
		}
	},
	"results": {
		<Name>: {
			"label": <Bezeichnung>,
			<Merkmal>: [
				<Merkmalsausprägung>
			]
		}
	},
	"rows": <Anzahl>
}

Veraltete Ausgabe

Hierbei ist der Ausgabeparameter mit „obsolete“ gesetzt.

{{#ask: [[Kategorie:Stadt]] [[liegt in::Deutschland]] 
| ?Bevölkerungszahl
| format=json
| syntax=obsolete
}}

Ergebnis: JSON

Struktur:

{
	"properties": {
		<Merkmal> : { "valueType": <Kennzeichen> }
	},
	"items": [
		{
			"label": <Bezeichnung>,
			"population": [<Merkmalsausprägung>]
		}
	]
}

Die Unterstützung für diese Ausgabeformatierung wird nur noch für den Versionszweig SWM 1.8.x aufrecht erhalten und hernach aufgegeben.



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

Help:JSON format de 1.8.0