Startseite
jump to top

Startseite / Erweiterte JSON-Unterstützung / Konfiguration

Konfiguration

Inhaltsverzeichnis

Die JSON-Ausgabe kann über das Systemobjekt #global.json konfiguriert werden.

formatVersion

$CMS_SET(#global.json.formatVersion, "1.1")$

Die zu verwendende Formatversion wird auf den angegebenen Wert gesetzt. Eine Formatversion legt die Struktur und die Attribute des erzeugten JSON fest. Wenn über FirstSpirit-Updates hinweg eine unveränderte JSON-Ausgabe benötigt wird, sollte die Format-Version explizit in den Projekteinstellungen unter „Globale Einstellungen“ gesetzt werden (siehe Projekteinstellungen (→Handbuch FirstSpirit SiteArchitect)).

Wenn die Formatversion nicht explizit eingestellt wird, dann wird immer die aktuelle JSON-Formatversion verwendet. Die Definition einer nicht unterstützten Formatversion führt zu einem Fehler.

prettyPrinting

$CMS_SET(#global.json.prettyPrinting, true)$

Schaltet das PrettyPrinting ein oder aus (Standard), wenn für den JSON-Ausgabekanal der JSON-Validator verwendet wird.

Wenn der Wert auf „false“ gesetzt ist, werden keine Leerzeichen verwendet, was es zur besten Option für den Datentransfer macht.

Wenn der Wert auf „true“ gesetzt ist, wird die Ausgabe für Menschen lesbarer gemacht, indem Einrückungen und andere Leerzeichen für die JSON-Ausgabe verwendet werden.

Die Einstellung kann auch mit JSON genutzt werden, das ohne die json() Funktion erzeugt wurde.

Wichtig PrettyPrinting wird nur unterstützt, wenn für die Ausgabe von JSON der JSON-Validator genutzt wird.

sectionTemplateRendering

$CMS_SET(#global.json.sectionTemplateRendering, true)$

Schaltet das Template-Rendering für Absatzelemente ein oder aus (Standard).

Wenn der Wert auf „true“ gesetzt ist, wird die Vorlage jedes Absatzes ausgewertet und das Ergebnis der Vorlage ist die JSON-Ausgabe.

Wenn der Wert auf „false“ gesetzt ist, dann werden die Inhalte der Absätze automatisch zusammen mit den Inhalten der Seite ausgegeben. Die einzelnen Absatzvorlagen werden hierbei nicht ausgewertet.

metaDataRendering

$CMS_SET(#global.json.metaDataRendering, true)$

Schaltet die Ausgabe von FirstSpirit Metadaten ein oder aus (Standard).

Wenn der Wert auf „true“ gesetzt ist, werden die Metadaten zu jeder Seite als eigenes JSON-Objekt ausgegeben.

Sind keine Metadaten gesetzt, so wird ein leeres Element ausgegeben.

dataRenderDepth

$CMS_SET(#global.json.dataRenderDepth, 1)$

Definiert, wieviele Ebenen bei der Ausgabe von Datensätzen ausgegeben werden sollen. Als Wert muss eine ganze Zahl übergeben werden.

Wert < 1 : Es wird nur eine Referenz auf den Datensatz ausgegeben.

Wert = 1 : Es wird der Datensatz ausgegeben und verknüpfte Datensätze werden als Referenz ausgegeben (Standard).

Wert >= 2 : Es wird der entsprechenden Anzahl an Fremdschlüsselbeziehungen gefolgt und die referenzierten Datensätze werden mit ausgegeben.
Hierbei ist zu beachten, dass die letzte Ebene nur als Referenz auf den entsprechenden Datensatz ausgegeben wird, für die darüberliegenden Ebenen wird auch der Inhalt der entsprechenden Datensätze ausgegeben.

Beispiel für eine entsprechende Referenz:

value": { 
"fsType": "DatasetReference",
"target": {
"fsType": "Dataset",
"schema": "Referenzketten",
"entityType": "Target1",
"identifier": "b9aa57bd-9561-4667-ac7c-3b98510c9e57",
}
}

© 2005 - 2020 e-Spirit AG | Alle Rechte vorbehalten. | FirstSpirit 2020-10 | Datenschutz | Impressum | Kontakt