Dies ist eine Dokumentation für das JSON-Datenformat, das umfangreiche Informationen zu verschiedenen Dokumenten enthält. Das JSON-Dokument enthält verschiedene Schlüssel-Wert-Paare, die detaillierte Informationen über jedes Dokument, die zugehörige Organisation, die Dokumentvorlage, die Dokumentlinks, die Dokumenttags, benutzerdefinierte Tags, den Status, die Erstellungs- und Aktualisierungszeitpunkte, die Veröffentlichungszeit, Vorschaubilder, das Layout und den eigentlichen Inhalt der Dokumente enthalten.
Das JSON-Dokument besteht aus einem Array von Objekten, wobei jedes Objekt Informationen über ein einzelnes Dokument enthält. Hier ist die allgemeine Struktur des JSON-Dokuments:
[
{
"uuid": "",
"title": "",
"organisation": {
// Informationen über die Organisation
},
"documentTemplate": {
// Informationen über die Dokumentvorlage
},
"documentLinks": [
// Liste von Dokumentlinks
],
"documentTags": [
// Liste von Dokumenttags
],
"documentCustomTags": [
// Liste von benutzerdefinierten Tags
],
"status": "",
"createdAt": "",
"updatedAt": "",
"publishedAt": "",
"previewImages": [
// Liste von Vorschaubildern
],
"documentLayout": {
// Informationen über das Dokumentlayout
},
"body": ""
},
// Weitere Dokumente...
]Eindeutige Kennung (UUID) für das Dokument.
Der Titel oder Name des Dokuments.
Ein Objekt, das Informationen über die Organisation enthält, die das Dokument erstellt hat. Es enthält die folgenden Schlüssel:
uuid: Eindeutige Kennung (UUID) für die Organisation.title: Der Titel oder Name der Organisation.description: Eine kurze Beschreibung der Organisation.color: Die Farbe der Organisation (in HEX-Format).createdAt: Der Zeitpunkt, an dem die Organisation erstellt wurde (in ISO 8601-Format).Ein Objekt, das Informationen über die Dokumentvorlage des Dokuments enthält. Es enthält die folgenden Schlüssel:
uuid: Eindeutige Kennung (UUID) für die Dokumentvorlage.title: Der Titel oder Name der Dokumentvorlage.description: Eine kurze Beschreibung der Dokumentvorlage.Eine Liste von Dokumentlinks, die auf andere Ressourcen oder Websites verweisen. Jeder Dokumentlink enthält die folgenden Schlüssel:
uuid: Eindeutige Kennung (UUID) für den Dokumentlink.title: Der Titel oder Name des Dokumentlinks.url: Die URL des Dokumentlinks.Eine Liste von Dokumenttags, die Informationen über bestimmte Themen oder Elemente im Dokument enthalten. Jeder Dokumenttag enthält die folgenden Schlüssel:
uuid: Eindeutige Kennung (UUID) für den Dokumenttag.title: Der Titel oder Name des Dokumenttags.content: Eine Liste von Inhalten, die mit dem Dokumenttag verknüpft sind. Jeder Inhalt enthält die folgenden Schlüssel:
uuid: Eindeutige Kennung (UUID) für den Inhalt.content: Der Inhalt des Tags.type: Der Typ des Tags (z. B. "isin" oder "wkn").Eine Liste von benutzerdefinierten Tags, die zusätzliche Informationen oder Kategorien für das Dokument bereitstellen.
Der Status des Dokuments (z. B. "new").
Der Zeitpunkt, an dem das Dokument erstellt wurde (in ISO 8601-Format).
Der Zeitpunkt, an dem das Dokument zuletzt aktualisiert wurde (in ISO 8601-Format).
Der Zeitpunkt, an dem das Dokument veröffentlicht wurde (in ISO 8601-Format).
Eine Liste von Vorschaubildern, die das Dokument visuell darstellen. Jedes Vorschaubild enthält die folgenden Schlüssel:
uuid: Eindeutige Kennung (UUID) für das Vorschaubild.originalName: Der ursprüngliche Name des Vorschaubilds.createdAt: Der Zeitpunkt, an dem das Vorschaubild erstellt wurde (in ISO 8601-Format).url: Die URL zum Abrufen des Vorschaubilds.mime: Der MIME-Typ des Vorschaubilds.Ein Objekt, das Informationen über das Layout des Dokuments enthält. Es enthält die folgenden Schlüssel:
uuid: Eindeutige Kennung (UUID) für das Layout.title: Der Titel oder Name des Layouts.description: Eine kurze Beschreibung des Layouts.Der eigentliche Inhalt des Dokuments, der in HTML-Format vorliegt.
Das JSON-Dokument enthält umfassende Informationen über verschiedene Dokumente, einschließlich der Dokumentdetails, Organisation, Dokumentvorlage, Links, Tags, benutzerdefinierter Tags, Status, Erstellungs- und Aktualisierungszeiten, Veröffentlichungszeit, Vorschaubildern, Layout und dem eigentlichen Inhalt. Diese Informationen können in verschiedenen Anwendungsfällen verwendet werden, um die Dokumente zu verwalten, anzuzeigen und weiter zu bearbeiten.