API REST pour l'exportation de tableaux de bord

Connexion à l'API

Point de terminaison (GET) :

/session/login

Paramètres :

Paramètre

Description

username

Nom d'utilisateur d'un utilisateur SKOOR

password

Mot de passe du même utilisateur

Exemple :

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

Déconnexion de l'API

Veuillez toujours vous déconnecter de l'API après avoir effectué les actions requises

Point de terminaison (GET) :

/session/logout

Paramètres :

Paramètre

Description

sessionId

ID de session SKOOR provenant de la requête de connexion de session

Exemple :

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

Paramètres pour les exportations

Paramètre

Description

dataQueries

Exporter les requêtes de données associées

files

Exporter les fichiers associés (par ex. des images)

theme

Exporter les thèmes associés (par ex. CSS, couleurs)

translations

Exporter les configurations de traduction associées

sessionId

ID de session SKOOR provenant de la requête de connexion de session

Exporter tous les tableaux de bord

Point de terminaison (GET) :

/dashboards/groups/root/export

Paramètres :

Exemple :

https://<SKOOR host>/skoor-webservice/dashboards/groups/root/export?dataQueries=true&files=true&theme=true&translations=true&sessionId=<sessionId>

Exporter un groupe de tableaux de bord

Point de terminaison (GET) :

/dashboards/groups/{groupId}/export

Exemple :

https://<SKOOR host>/skoor-webservice/dashboards/groups/719/export?dataQueries=true&files=true&theme=true&translations=true&sessionId=<sessionId>

Trouver l'ID d'un groupe de tableaux de bord

Pour trouver l'ID d'un groupe, effectuez une exportation manuellement depuis le menu du groupe requis et cochez la case Plain JSON dans la boîte de dialogue d'exportation :

image-20240409-100807.png

Recherchez ensuite la clé id dans la chaîne JSON :

image-20240409-100930.png

Exporter un seul tableau de bord

Point de terminaison (GET) :

/dashboards/{dashboardId}/export

Exemple :

https://<SKOOR host>/skoor-webservice/dashboards/10842/export?dataQueries=true&files=true&theme=true&translations=true&sessionId=<sessionId>

Trouver l'ID d'un tableau de bord

Comme décrit pour les exportations de groupes de tableaux de bord, l'ID du tableau de bord peut être trouvé dans la boîte de dialogue d'une exportation manuelle. Recherchez un objet de type dashboard et de subType dashboard pour obtenir la bonne clé id :

image-20240409-101759.png