DocsAPI REST pour l'exportation du tableau de bord
Connectez-vous à 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>
Se déconnecter 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 issu 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 |
|---|---|
| Exporter les requêtes de données associées |
| Exporter des fichiers associés (par exemple des images) |
| Exporter des thèmes associés (par exemple CSS, couleurs) |
| Exporter les configurations de traduction associées |
| Identifiant de session SKOOR issu de la demande de connexion à la 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 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'identifiant du groupe de tableau de bord
Pour trouver l'identifiant d'un groupe, effectuez une exportation manuellement à 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 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'identifiant du tableau de bord se trouve dans la boîte de dialogue d'une exportation manuelle. Recherchez un objet de type tableau de bord et sous-Type tableau de bord pour obtenir la clé d'identification correcte :
