DocumentationAPI REST pour l'exportation de tableaux de bord
Connexion à l'API
Point de terminaison (GET) :
/session/login
Paramètres :
Paramètre | Description |
|---|---|
| Nom d'utilisateur d'un utilisateur SKOOR |
| 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 |
|---|---|
| Identifiant de session SKOOR provenant de la demande de connexion à la session |
Exemple :
https://<SKOOR host>/skoor-webservice/session/logout?sessionId=<sessionId>
Paramètres pour les exportations
Paramètre | Description |
|---|---|
| Requêtes de données liées à l'exportation |
| Exportation de fichiers associés (par exemple, images) |
| Exportation des thèmes associés (par exemple, CSS, couleurs) |
| Exporter les configurations de traduction associées |
| Identifiant de session SKOOR provenant de la demande de connexion à la session |
Exportation de 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 le 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>
Rechercher l'ID d'un groupe de tableaux de bord
Pour trouver l'ID d'un groupe, effectuez manuellement une exportation à partir du menu des groupes requis et cochez la case JSON simple dans la boîte de dialogue d'exportation :
Recherchez ensuite la clé d'identifiant dans la chaîne JSON :
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>
Rechercher l'identifiant du tableau de bord
Comme décrit pour les exportations de groupes de tableaux de bord, l'ID du tableau de bord se trouve dans la boîte de dialogue d'une exportation manuelle. Recherchez un objet de type dashboard et de sous-type dashboard pour obtenir la clé d'identification correcte :
