API REST pour l'exportation de tableaux de bord

Connexion à l'API

Point final (GET) :

/session/login

Paramètres :

Paramètre	Description du paramètre
`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 final (GET) :

/session/logout

Paramètres :

Paramètre	Description du paramètre
`sessionId`	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 des paramètres
`dataQueries`	Exporter les requêtes de données connexes
`files`	Exporter les fichiers connexes (par exemple, les images)
`theme`	Exporter les thèmes liés (par exemple CSS, couleurs)
`translations`	Exporter les configurations de traduction associées
`sessionId`	Identifiant de session SKOOR provenant de la demande de connexion à la session

Exporter tous les tableaux de bord

Point final (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 final (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'identifiant d'un groupe de tableaux de bord

Pour trouver l'identifiant d'un groupe, procédez à une exportation manuelle à partir du menu des groupes requis et cochez la case Plain JSON dans la boîte de dialogue d'exportation :

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

Exporter un tableau de bord unique

Point d'arrivée (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'identifiant du tableau de bord peut être trouvé dans la boîte de dialogue d'une exportation manuelle. Recherchez un objet de type tableau de bord et de sous-type tableau de bord pour obtenir la clé d'identification correcte :