DokumentationREST API für den Dashboard-Export
Anmeldung bei der 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>
Abmelden von der API
Bitte melden Sie sich nach Durchführung der erforderlichen Aktionen immer von der API ab.
Endpunkt (GET):
/session/logout
Parameter:
Parameter | Beschreibung |
|---|---|
| SKOOR-Sitzungs-ID aus der Sitzungsanmeldeanforderung |
Beispiel:
https://<SKOOR host>/skoor-webservice/session/logout?sessionId=<sessionId>
Parameter für Exporte
Parameter | Beschreibung |
|---|---|
| Exportbezogene Datenabfragen |
| Exportbezogene Dateien (z. B. Bilder) |
| Exportbezogene Themen (z. B. CSS, Farben) |
| Exportieren von zugehörigen Übersetzungskonfigurationen |
| SKOOR-Sitzungs-ID aus der Sitzungsanmeldeanforderung |
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 suchen
Um die ID einer Gruppe zu finden, führen Sie einen Export manuell über das Menü „Erforderliche Gruppen” durch und aktivieren Sie im Exportdialog das Kontrollkästchen „Plain JSON”:
Suchen Sie dann in der JSON-Zeichenfolge nach dem ID-Schlüssel:
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 finden
Wie für den Export von Dashboard-Gruppen beschrieben, finden Sie die Dashboard-ID im Dialogfeld für den manuellen Export. Suchen Sie nach einem Objekt vom Typ „Dashboard” und Untertyp „Dashboard”, um den richtigen ID-Schlüssel zu erhalten:
