Help:Ergebnisformat json

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	Legt fest, welche alternative Datenquelle für die Ermittlung der Abfrageergebnisse genutzt werden soll
limit	Ganzzahl	100	Legt fest, wie viele Ergebnisse bei der Ausgabe der Abfrageergebnisse maximal angezeigt werden sollen
offset	Ganzzahl	0	Legt fest, ab dem wievielten Ergebnis mit der Ausgabe der Abfrageergebnisse begonnen werden soll
link	Text	all	Legt fest, ob die Datenwerte der Ergebnisse bei der Ausgabe der Abfrageergebnisse als Link angezeigt werden sollen
sort	Liste mit Texten	leer	Legt fest, nach welchem Attribut sortiert die Ergebnisse bei der Ausgabe der Abfrageergebnisse angezeigt werden sollen
order	Liste mit Texten	leer	Legt fest, in welcher Sortierreihenfolge die Ergebnisse bei der Ausgabe der Abfrageergebnisse angezeigt werden sollen
headers	Text	show	Legt fest, ob Überschriften bzw. Attributbezeichnungen bei der Ausgabe der Abfrageergebnisse verwendet werden sollen
mainlabel	Text	no	Legt fest, welche Überschrift oder Bezeichnung für die Hauptergebnisspalte bei der Ausgabe der Abfrageergebnisse angezeigt werden soll
intro	Text	leer	Legt fest, welcher Text vor der Ausgabe der Abfrageergebnisse angezeigt werden soll
outro	Text	leer	Legt fest, welcher Text nach der Ausgabe der Abfrageergebnisse angezeigt werden soll
searchlabel	Text	JSON	Legt fest, welcher Text als Link zur Ausgabe weiterer Abfrageergebnisse angezeigt werden soll
default	Text	leer	Legt fest, welcher Text angezeigt werden soll, sofern keine Abfrageergebnisse vorhanden sind

Format specific

Parameter	Typ	Standard	Beschreibung
type	Text	full	Legt fest, welcher Serialisierungstyp bei der Ausgabe der Abfrageergebnisse verwendet werden soll
prettyprint	ja/nein	leer	Legt fest, ob zusätzliche Einzüge und neue Zeilen bei der Ausgabe der Abfrageergebnisse verwendet werden sollen
unescape	ja/nein	leer	Legt fest, ob maskierte Schrägstriche und aus mehreren Bytes bestehende Unicode-Zeichen bei der Ausgabe der Abfrageergebnisse verwendet werden sollen
filename	Text	result.json	Legt fest, welcher Name für die Ausgabedatei verwendet werden soll

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: fr

Help:JSON format de 1.8.0