- Stampa
::: (info) () Per scaricare l'applicazione, visitare: Biblioteca:::
Connettore Microsoft Excel
Integrazione con Microsoft O365 Worksheet V1.0 Api
Introduzione
L'API Microsoft Excel Worksheets consente agli utenti di creare, leggere e modificare i fogli di Microsoft Excel con il giusto accesso ai loro account Office365. L'obiettivo di questo connettore è integrare Tulip con Microsoft utilizzando l'API Graph di Microsoft (v1.0) tramite i connettori HTTP e fornire ai nostri clienti un connettore pronto all'uso che può essere importato nella loro istanza.
Scopo
Questo documento evidenzierà le diverse funzioni del connettore che possono essere costruite effettuando chiamate HTTP alla Graph API (v1.0) di Microsoft per interagire con il foglio di lavoro Excel di M365 per mostrare varie azioni di lettura e scrittura sul foglio di lavoro che potrebbero essere sfruttate per vari casi d'uso.
Documentazione API
Documentazione dell'API Graph di Microsoft
Prerequisiti
- Creare un account su Microsoft O365 e configurare le credenziali OAuth 2.0 in Microsoft Entra ID.
- Registrare l'API con gli ambiti richiesti nel portale Microsoft. Azure - Entra ID
Video di impostazione del connettore:
Dettagli della connessione Tulip
Le seguenti informazioni devono essere configurate in Tulip.
Connettori.
- In esecuzione su: Host del connettore cloud
- Host: graph.microsoft.com
- Porta: 443
- TLS: Sì
OAuth 2: per ottenere il token di accesso per comunicare con l'API Graph di Microsoft.
Funzioni del connettore
1) Ottenere i dettagli di un'unità
Scopo
Questo connettore recupera tutti gli elementi di un'unità.
Punto finale
Chiamata HTTP POST all'endpoint -https://graph.micrsoft.com:443/v1.0/me/drive/root/children
Input richiesti
Nessun ingresso richiesto
Estrattore di output richiesto
- SheetID: identificatore univoco della cartella di lavoro che verrà utilizzata per eseguire le altre operazioni.
- CreatedAt: Data e ora di creazione della cartella di lavoro.
- LastModified: Data e ora dell'ultima modifica della cartella di lavoro.
- NomeFoglio: Il nome della cartella di lavoro.
- SpreadSheetURL: L'URL della cartella di lavoro.
2) Ottenere tutti i fogli di lavoro di una cartella di lavoro
Scopo
Questo connettore recupera tutti i fogli di lavoro di una cartella di lavoro passando il workbookID.
Punto finale
HTTP GET all'endpoint -https://graph.microsoft.com:443/v1.0/me/drive/items/{workbookID}/workbook/worksheets
Input richiesti
I parametri URL da passare sono i seguenti
- Id cartella di lavoro
Estrattore di output richiesto
- sheetId: Identificatore univoco del foglio di calcolo che verrà utilizzato per eseguire le altre operazioni.
- sheetName:il nome visualizzato del foglio di lavoro.
- sheetPosition:la posizione a base zero del foglio di lavoro all'interno della cartella di lavoro.
- sheetVisibility: La visibilità del foglio di lavoro. I valori possibili sono Visibile, Nascosto, Molto nascosto.
3) Ottenere i metadati del foglio di lavoro
Scopo
Questo connettore recupera i dati da WorkbookID e Worksheet Name.
Punto finale
Chiamata HTTP GET all'endpoint https://graph.microsoft.com:443/v1.0/me/drive/items/{workbookID}/workbook/worksheets/{worksheetName}/
Input richiesti
I parametri URL da passare sono i seguenti
- ID cartella di lavoro
- Nome del foglio di lavoro
Estrattore di output richiesto
- sheetId: Identificatore univoco del foglio di calcolo che verrà utilizzato per eseguire le altre operazioni.
- sheetName:il nome visualizzato del foglio di lavoro.
- sheetPosition:la posizione a base zero del foglio di lavoro all'interno della cartella di lavoro.
- sheetVisibility: La visibilità del foglio di lavoro. I valori possibili sono: Visibile, Nascosto, Molto nascosto.
4) Creare un nuovo foglio di lavoro
Scopo
- Gli utenti possono passare un ID cartella di lavoro e un nome di foglio di lavoro come input e Tulip creerà un nuovo foglio di lavoro con il nome del foglio fornito. La risposta dell'API sarà costituita dai metadati e dalle varie proprietà del foglio di lavoro. Questo può essere ulteriormente utilizzato per recuperare e aggiornare i dati dai fogli di lavoro.
- Le informazioni estratte dall'API Microsoft Graph V1.0 possono essere utilizzate all'interno delle applicazioni Tulip, delle tabelle Tulip o delle variabili Tulip che vengono convogliate in altre funzioni del connettore.
Punto finale
Chiamata HTTP POST all'endpoint https://graph.microsoft.com:443/v1.0/me/drive/items/{workbookID}/workbook/worksheets/add
Input richiesti
I parametri che vengono inviati come corpo della richiesta sono i seguenti
- ID cartella di lavoro - L'ID della cartella di lavoro
- Nome del foglio di lavoro - Titolo del foglio di lavoro
Estrattore di output richiesto
- WorksheetId: Identificatore univoco del foglio di calcolo che verrà utilizzato per eseguire le altre operazioni.
- spreadsheetURL: L'URL del foglio di calcolo appena creato.
- I parametri aggiuntivi che vengono restituiti con la risposta possono essere inclusi come parte dei parametri di output.
5) Aggiornare le proprietà del foglio di lavoro
Scopo
Gli utenti possono passare un ID cartella di lavoro, il nome del vecchio foglio di lavoro, la posizione del foglio di lavoro e il nome del nuovo foglio di lavoro come input e Tulip aggiornerà il foglio di lavoro con il nome del foglio fornito. La risposta dell'API sarà costituita dai metadati e dalle varie proprietà del foglio di lavoro. Questo può essere ulteriormente utilizzato per recuperare e aggiornare i dati dai fogli di lavoro.
Punto finale
Chiamata HTTP PATCH al punto finale -https://graph.microsoft.com:443/v1.0/me/drive/items/{workbookID}/workbook/worksheets/{worksheetName}
Input richiesti
I parametri che vengono inviati come corpo della richiesta sono i seguenti
- ID cartella di lavoro - L'ID della cartella di lavoro
- Nome del foglio di lavoro - Titolo del foglio di lavoro
- Posizione del foglio di lavoro - La posizione a base zero del foglio di lavoro all'interno della cartella di lavoro.
- Nome del nuovo foglio di lavoro - Titolo del nuovo foglio di lavoro
Estrattore di output richiesto
- sheetID: identificatore univoco della cartella di lavoro che verrà utilizzata per eseguire le altre operazioni
- sheetName: Il nome visualizzato del foglio di lavoro.
- sheetPosition: la posizione a base zero del foglio di lavoro all'interno della cartella di lavoro.
6) Ottenere i dati di una cella specifica
Scopo
Questo connettore recupera i dati dai fogli di lavoro di una cartella di lavoro in base a WorkbookID, Worksheet Name, Row index e Column index forniti come input. La risposta dell'API sarà il valore della cella fornita.
Punto finale
Chiamata HTTP GET all'endpoint -https://graph.microsoft.com:443/v1.0/me/drive/items/{workbookID}/workbook/worksheets/{worksheetName}/cell
(row={row index},column={column index})
Input richiesti
I parametri URL da passare sono i seguenti
- Id della cartella di lavoro - ID della cartella di lavoro
- Nome del foglio di lavoro - Titolo del foglio di lavoro
- Indice di riga- Numero di riga della cella da recuperare
- Indice di colonna: numero di colonna della cella da recuperare.
Estrattore di output richiesto
Questo connettore restituisce il valore della cella dell'indice di riga e di colonna fornito.
7) Ottenere i dati dell'intervallo del foglio di lavoro
Scopo
Questo connettore recupera i dati dai fogli di lavoro di una cartella di lavoro in base a WorkbookID, Nome foglio di lavoro, Intervallo iniziale e Intervallo finale forniti come input. La risposta dell'API sarà costituita dai dati dell'intervallo fornito.
Punto finale
Chiamata HTTP GET all'endpoint -https://graph.microsoft.com:443/v1.0/me/drive/items/{workbookID}/workbook/worksheets/{worksheetName}/range
(address='{start range}:{end range}')
Input richiesti
I parametri URL da passare sono i seguenti
- Id della cartella di lavoro- ID della cartella di lavoro
- Nome del foglio di lavoro - Titolo del foglio di lavoro
- Intervallo iniziale- Intervallo iniziale
- Intervallo finale- Intervallo finale
Estrattore di output richiesto
Questo connettore restituisce tutti i valori delle celle all'interno dell'intervallo fornito.
8) Aggiorna i valori per intervallo
Scopo
Gli utenti possono passare l'ID della cartella di lavoro, il nome del foglio di lavoro, l'intervallo iniziale, l'intervallo finale e i valori da aggiornare come input e Tulip aggiornerà i valori dell'intervallo con l'intervallo fornito. La risposta dell'API sarà costituita dai valori aggiornati dell'intervallo.
Punto finale
Chiamata HTTP PATCH all'endpoint -https://graph.microsoft.com:443/v1.0/me/drive/items/{workbookID}/workbook/worksheets/{worksheetName}/range
(address='{start range}:{end range}')
Input richiesti
I parametri URL da passare sono i seguenti
- Id della cartella di lavoro- ID della cartella di lavoro
- Nome del foglio di lavoro - Titolo del foglio di lavoro
- Intervallo iniziale- Intervallo iniziale
- Intervallo finale- Intervallo finale
- Valori di ogni cella all'interno dell'intervallo fornito
Estrattore di output richiesto
Non è richiesto alcun estrattore di output.
9) Creare una tabella nel foglio di lavoro
Scopo
- Gli utenti possono passare l'ID della cartella di lavoro, il nome del foglio di lavoro, l'indirizzo del foglio di lavoro e le intestazioni come input e Tulip creerà una nuova tabella con il nome della tabella. La risposta dell'API sarà costituita dai metadati e dalle varie proprietà della tabella.
- Queste possono essere ulteriormente utilizzate per recuperare e aggiornare i dati dai fogli di calcolo.
- Le informazioni estratte dall'API di Microsoft Graph V1.0 possono essere utilizzate all'interno delle applicazioni Tulip, delle tabelle Tulip o delle variabili Tulip che vengono convogliate in altre funzioni del connettore.
Punto finale
Chiamata HTTP POST all'endpoint https://graph.microsoft.com:443/v1.0/me/drive/items/{itemID}/workbook/worksheets/add
Input richiesti
I parametri che vengono inviati come corpo della richiesta sono i seguenti
- ID cartella di lavoro - L'ID della cartella di lavoro
- Nome del foglio di lavoro - Titolo del foglio di lavoro
- Indirizzo - Indirizzo o nome dell'oggetto intervallo che rappresenta l'origine dati. Se l'indirizzo non contiene un nome di foglio, viene utilizzato il foglio attualmente attivo.
- hasHeaders-Valore booleano che indica se i dati importati hanno etichette di colonna. Se l'origine non contiene intestazioni (cioè quando questa proprietà è impostata su false), Excel genererà automaticamente un'intestazione spostando i dati di una riga verso il basso.
Estrattore di output richiesto
Restituisce i valori dei metadati della tabella appena creata.
10) Aggiungere una nuova riga in una tabella
Scopo
Gli utenti possono passare l'ID della cartella di lavoro, il nome della tabella e i valori della riga come input e Tulip creerà una nuova riga con i valori della riga forniti. La risposta dell'API sarà il valore della riga creata nella tabella.
Punto finale
Chiamata HTTP POST all'endpoint https://graph.microsoft.com:443/v1.0/me/drive/items/{workbookID}/workbook/tables/{tablename}/rows/add
Input richiesti
I parametri inviati come corpo della richiesta sono i seguenti
- ID cartella di lavoro - L'ID della cartella di lavoro
- Nome del foglio di lavoro - Titolo del foglio di lavoro
- Valori delle righe
Estrattore di output richiesto
Restituisce i valori di riga della nuova riga creata.
11) Cancella i dati del foglio di lavoro
Scopo
Gli utenti possono inserire l'ID della cartella di lavoro, il nome del foglio di lavoro, l'intervallo iniziale e l'intervallo finale e Tulip cancellerà i valori delle celle in base all'intervallo indicato.
Punto finale
Chiamata HTTP POST all'endpoint https://graph.microsoft.com:443/v1.0/me/drive/items/{workbookID}/workbook/worksheet/{worksheetName}/range
(address='{start range}:{end range}')/clear
Input richiesti
I parametri inviati come corpo della richiesta sono i seguenti
- ID cartella di lavoro - L'ID della cartella di lavoro
- Nome del foglio di lavoro - Titolo del foglio di lavoro
- Intervallo iniziale
- Intervallo finale
Ulteriori informazioni
Ulteriori informazioni sui connettori Microsoft