REST-API für den Dashboard-Export

Anmeldung bei API

Endpunkt (GET):

/session/login

Parameter:

Parameter

Beschreibung

username

Benutzername eines SKOOR-Benutzers

password

Passwort des gleichen Benutzers

Beispiel:

https://<SKOOR host>/skoor-webservice/session/login?username=<username>&password=<password>

Von der API abmelden

Bitte melden Sie sich immer von der API ab, nachdem Sie die erforderlichen Aktionen ausgeführt haben

Endpunkt (GET):

/session/logout

Parameter:

Parameter

Beschreibung

sessionId

SKOOR-Sitzungs-ID aus der Sitzungs-Anmeldeanforderung

Beispiel:

https://<SKOOR host>/skoor-webservice/session/logout?sessionId=<sessionId>

Parameter für Exporte

Parameter

Beschreibung

dataQueries

Exportbezogene Datenabfragen

files

Exportieren zugehöriger Dateien (z. B. Bilder)

theme

Exportieren Sie verwandte Themen (z. B. CSS, Farben).

translations

Exportieren zugehöriger Übersetzungskonfigurationen

sessionId

SKOOR-Sitzungs-ID aus der Sitzungs-Anmeldeanforderung

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>

Dashboardgruppe 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>

Suchen Sie nach der Dashboard-Gruppen-ID

Um die ID einer Gruppe zu finden, führen Sie einen Export manuell über das Menü der erforderlichen Gruppen durch und aktivieren Sie im Exportdialog das Kontrollkästchen „Einfaches JSON“ :

bild-20240409-100807.png

Suchen Sie dann nach dem ID-Schlüssel in der JSON-Zeichenfolge:

bild-20240409-100930.png

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 beim Export von Dashboard-Gruppen beschrieben, kann die Dashboard-ID im Dialog eines manuellen Exports gefunden werden. Suchen Sie nach einem Objekt vom Typ Dashboard und dem Untertyp Dashboard , um den richtigen ID-Schlüssel zu erhalten:

bild-20240409-101759.png