DokumentationREST API für den Dashboard-Export
Anmeldung bei API
Endpunkt (GET):
/session/login
Parameter:
Parameter | Beschreibung |
|---|---|
| Benutzername eines SKOOR-Benutzers |
| Passwort desselben Benutzers |
Beispiel:
https://<SKOOR host>/skoor-webservice/session/login?username=<username>&password=<password>
Abmeldung von API
Bitte melden Sie sich immer von der API ab, nachdem Sie die erforderlichen Aktionen durchgeführt haben
Endpunkt (GET):
/session/logout
Parameter:
Parameter | Beschreibung |
|---|---|
| SKOOR-Sitzungsnummer aus der Anfrage zur Sitzungsanmeldung |
Beispiel:
https://<SKOOR host>/skoor-webservice/session/logout?sessionId=<sessionId>
Parameter für Exporte
Parameter | Beschreibung |
|---|---|
| Exportbezogene Datenabfragen |
| Zugehörige Dateien exportieren (z. B. Bilder) |
| Export von verwandten Themen (z.B. CSS, Farben) |
| Export von Übersetzungskonfigurationen |
| SKOOR-Sitzungsnummer aus der Sitzungsanmeldung |
Alle Dashboards exportieren
Endpunkt (GET):
/dashboards/groups/root/export
Parameter:
Beispiel:
https://<SKOOR host>/skoor-webservice/dashboards/groups/root/export?dataQueries=true&files=true&theme=true&translations=true&sessionId=<sessionId>
Dashboard-Gruppe exportieren
Endpunkt (GET):
/dashboards/groups/{groupId}/export
Beispiel:
https://<SKOOR host>/skoor-webservice/dashboards/groups/719/export?dataQueries=true&files=true&theme=true&translations=true&sessionId=<sessionId>
Dashboard-Gruppen-ID finden
Um die ID einer Gruppe zu finden, führen Sie einen manuellen Export aus dem Menü "Erforderliche Gruppen" durch und aktivieren das Kontrollkästchen "Plain JSON" im Exportdialog:
Suchen Sie dann nach dem Schlüssel id in der JSON-Zeichenkette:
Einzelnes Dashboard exportieren
Endpunkt (GET):
/dashboards/{dashboardId}/export
Beispiel:
https://<SKOOR host>/skoor-webservice/dashboards/10842/export?dataQueries=true&files=true&theme=true&translations=true&sessionId=<sessionId>
Dashboard-ID suchen
Wie für den Export von Dashboard-Gruppen beschrieben, kann die Dashboard-ID im Dialog eines manuellen Exports gefunden werden. Suchen Sie nach einem Objekt des Typs Dashboard und des Subtyps Dashboard, um den richtigen ID-Schlüssel zu erhalten:
