API REST per l'esportazione del cruscotto

Accedi all'API

Endpoint (GET):

/session/login

Parametri:

Parametro

Descrizione

username

Nome utente di un utente SKOOR

password

Password dello stesso utente

Esempio:

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

Logout dall'API

Si prega di effettuare sempre il logout dall'API dopo aver eseguito le azioni richieste

Endpoint (GET):

/session/logout

Parametri:

Parametro

Descrizione

sessionId

ID sessione SKOOR dalla richiesta di accesso alla sessione

Esempio:

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

Parametri per le esportazioni

Parametro

Descrizione

dataQueries

Query relativa all'esportazione dei dati

files

File relativi all'esportazione (ad es. immagini)

theme

Esportazione di temi correlati (ad es. CSS, colori)

translations

Esporta configurazioni di traduzione correlate

sessionId

ID sessione SKOOR dalla richiesta di accesso alla sessione

Esportazione di tutti i dashboard

Endpoint (GET):

/dashboards/groups/root/export

Parametri:

Esempio:

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

Esporta gruppo di dashboard

Endpoint (GET):

/dashboards/groups/{groupId}/export

Esempio:

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

Trova ID gruppo dashboard

Per trovare l'ID di un gruppo, esegui manualmente un'esportazione dal menu dei gruppi richiesti e seleziona la casella di controllo JSON semplice nella finestra di dialogo di esportazione:

image-20240409-100807.png

Quindi cerca la chiave ID nella stringa JSON:

image-20240409-100930.png

Esporta singola dashboard

Endpoint (GET):

/dashboards/{dashboardId}/export

Esempio:

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

Trova l'ID del dashboard

Come descritto per le esportazioni di gruppi di dashboard, l'ID della dashboard può essere trovato nella finestra di dialogo di un'esportazione manuale. Cerca un oggetto di tipo dashboard e sottotipo dashboard per ottenere la chiave ID corretta:

image-20240409-101759.png