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
| ⧼validator-describe-header-parameter⧽ | ⧼validator-describe-header-type⧽ | ⧼validator-describe-header-default⧽ | ⧼validator-describe-header-description⧽ |
|---|---|---|---|
| source | ⧼validator-type-string⧽ | ⧼validator-describe-empty⧽ | Legt fest, welche alternative Datenquelle für die Ermittlung der Abfrageergebnisse genutzt werden soll |
| limit | ⧼validator-type-integer⧽ | 100 | Legt fest, wie viele Ergebnisse bei der Ausgabe der Abfrageergebnisse maximal angezeigt werden sollen |
| offset | ⧼validator-type-integer⧽ | 0 | Legt fest, ab dem wievielten Ergebnis mit der Ausgabe der Abfrageergebnisse begonnen werden soll |
| link | ⧼validator-type-string⧽ | all | Legt fest, ob die Datenwerte der Ergebnisse bei der Ausgabe der Abfrageergebnisse als Link angezeigt werden sollen |
| sort | ⧼validator-type-string-list⧽ | ⧼validator-describe-empty⧽ | Legt fest, nach welchem Attribut sortiert die Ergebnisse bei der Ausgabe der Abfrageergebnisse angezeigt werden sollen |
| order | ⧼validator-type-string-list⧽ | ⧼validator-describe-empty⧽ | Legt fest, in welcher Sortierreihenfolge die Ergebnisse bei der Ausgabe der Abfrageergebnisse angezeigt werden sollen |
| headers | ⧼validator-type-string⧽ | show | Legt fest, ob Überschriften bzw. Attributbezeichnungen bei der Ausgabe der Abfrageergebnisse verwendet werden sollen |
| mainlabel | ⧼validator-type-string⧽ | no | Legt fest, welche Überschrift oder Bezeichnung für die Hauptergebnisspalte bei der Ausgabe der Abfrageergebnisse angezeigt werden soll |
| intro | ⧼validator-type-string⧽ | ⧼validator-describe-empty⧽ | Legt fest, welcher Text vor der Ausgabe der Abfrageergebnisse angezeigt werden soll |
| outro | ⧼validator-type-string⧽ | ⧼validator-describe-empty⧽ | Legt fest, welcher Text nach der Ausgabe der Abfrageergebnisse angezeigt werden soll |
| searchlabel | ⧼validator-type-string⧽ | JSON | Legt fest, welcher Text als Link zur Ausgabe weiterer Abfrageergebnisse angezeigt werden soll |
| default | ⧼validator-type-string⧽ | ⧼validator-describe-empty⧽ | Legt fest, welcher Text angezeigt werden soll, sofern keine Abfrageergebnisse vorhanden sind |
Format specific
| ⧼validator-describe-header-parameter⧽ | ⧼validator-describe-header-type⧽ | ⧼validator-describe-header-default⧽ | ⧼validator-describe-header-description⧽ |
|---|---|---|---|
| type | ⧼validator-type-string⧽ | full | Legt fest, welcher Serialisierungstyp bei der Ausgabe der Abfrageergebnisse verwendet werden soll |
| prettyprint | ⧼validator-type-boolean⧽ | ⧼validator-describe-empty⧽ | Legt fest, ob zusätzliche Einzüge und neue Zeilen bei der Ausgabe der Abfrageergebnisse verwendet werden sollen |
| unescape | ⧼validator-type-boolean⧽ | ⧼validator-describe-empty⧽ | Legt fest, ob maskierte Schrägstriche und aus mehreren Bytes bestehende Unicode-Zeichen bei der Ausgabe der Abfrageergebnisse verwendet werden sollen |
| filename | ⧼validator-type-string⧽ | 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.
Property "Namespace" has a restricted application area and cannot be used as annotation property by a user.Property "Docinfo editor" (as page type) with input value "User:>Kghbln" contains invalid characters or is incomplete and therefore can cause unexpected results during a query or annotation process.
