Conector do Microsoft Excel

::: (info) () Para fazer o download do aplicativo, visite: Biblioteca::::

Conector do Microsoft Excel

Integração com a Microsoft O365 Worksheet V1.0 Api

Introdução

A API do Microsoft Excel Worksheets permite que os usuários criem, leiam e editem planilhas do Microsoft Excel com o acesso correto definido para suas contas do Office365. O objetivo desse conector é integrar a Tulip com a Microsoft usando a API Graph da Microsoft (v1.0) por meio de conectores HTTP e fornecer aos nossos clientes um conector pronto para uso que possa ser importado para sua instância.

Objetivo

Este documento destacará diferentes funções de conector que podem ser criadas por meio de chamadas HTTP para a API Graph da Microsoft (v1.0) para interagir com a planilha do Excel M365 e mostrar várias ações de leitura e gravação na planilha que podem ser aproveitadas para vários casos de uso.

Documento da API

Documentação da API do Microsoft Graph

Pré-requisitos

1. Criar uma conta no Microsoft O365 e configurar as credenciais do OAuth 2.0 no Microsoft Entra ID.
2. Registre a API com os escopos necessários no portal da Microsoft. Azure - Entra ID

Vídeo de configuração do conector:

Detalhes da conexão Tulip

As informações a seguir precisariam ser configuradas na seção

Conectores.

1. Em execução: host do conector de nuvem
2. Host: graph.microsoft.com
3. Porta:443
4. TLS: sim

OAuth 2: para obter o token de acesso para se comunicar com a API do Graph da Microsoft

Funções do conector

1) Obter detalhes de uma unidade

Objetivo

Esse conector buscará todos os itens de uma unidade.

Ponto final

Chamada HTTP POST para o ponto de extremidade -https://graph.micrsoft.com:443/v1.0/me/drive/root/children

Entrada necessária

Não são necessárias entradas

Extrator de saída necessário

1. SheetID: identificador exclusivo da pasta de trabalho que será usada para executar as outras tarefas.
2. CreatedAt: A data e a hora de criação da pasta de trabalho.
3. LastModified (Última modificação): A data e a hora da última modificação da pasta de trabalho.
4. SheetName: O nome da pasta de trabalho.
5. SpreadSheetURL: O URL da pasta de trabalho.

2) Obter todas as planilhas em uma pasta de trabalho

Objetivo

Esse conector buscará todas as planilhas de uma pasta de trabalho passando o workbookID.

Ponto de extremidade

HTTP GET para o ponto de extremidade -https://graph.microsoft.com:443/v1.0/me/drive/items/{workbookID}/workbook/worksheets

Entrada obrigatória

A seguir estão os parâmetros de URL que devem ser passados

1. ID da pasta de trabalho

Extractor de saída obrigatório

1. sheetId: Identificador exclusivo da SpreadSheet que será usada para executar as outras tarefas.
2. sheetName: O nome de exibição da planilha.
3. sheetPosition: A posição baseada em zero da planilha dentro da pasta de trabalho.
4. sheetVisibility: A visibilidade da planilha. Os valores possíveis são Visible, Hidden, VeryHidden.

3) Obter metadados da planilha

Objetivo

Esse conector buscará os dados do WorkbookID e do Worksheet Name.

Ponto de extremidade

Chamada HTTP GET para o ponto de extremidade https://graph.microsoft.com:443/v1.0/me/drive/items/{workbookID}/workbook/worksheets/{worksheetName}/

Entrada obrigatória

A seguir estão os parâmetros de URL que devem ser passados

1. ID da pasta de trabalho
2. Nome da planilha

Extrator de saída obrigatório

1. sheetId: Identificador exclusivo da SpreadSheet que será usada para executar as outras tarefas.
2. sheetName: O nome de exibição da planilha.
3. sheetPosition: A posição baseada em zero da planilha dentro da pasta de trabalho.
4. sheetVisibility: A visibilidade da planilha. Os valores possíveis são: Visible, Hidden, VeryHidden.

4) Criação de uma nova planilha

Objetivo

1. Os usuários podem passar o ID da pasta de trabalho e o nome da planilha como entrada e a Tulip criará uma nova planilha com o nome da planilha fornecido. A resposta da API será os metadados e várias propriedades da planilha. Isso pode ser usado posteriormente para buscar e atualizar dados das planilhas.
2. As informações extraídas da API do Microsoft Graph V1.0 podem ser usadas em aplicativos Tulip, tabelas Tulip ou variáveis Tulip que seriam canalizadas para outras funções do conector.

Ponto final

Chamada HTTP POST para o endpoint https://graph.microsoft.com:443/v1.0/me/drive/items/{workbookID}/workbook/worksheets/add

Entrada obrigatória

Os parâmetros a seguir são enviados como o corpo da solicitação

1. Workbook ID - O ID da pasta de trabalho
2. Worksheet Name - Título da planilha

Extrator de saída obrigatório

1. WorksheetId: Identificador exclusivo da SpreadSheet que será usada para executar as outras tarefas.
2. spreadsheetURL: O URL da planilha recém-criada.
3. Parâmetros adicionais que são retornados com a resposta podem ser incluídos como parte dos parâmetros de saída.

5) Atualizar propriedades da planilha

Objetivo

Os usuários podem passar o ID da pasta de trabalho, o nome da planilha antiga, a posição da planilha e o nome da nova planilha como entrada e o Tulip atualizará a planilha com o nome da planilha fornecido. A resposta da API será os metadados e várias propriedades da planilha. Isso pode ser usado posteriormente para buscar e atualizar dados das planilhas.

Ponto final

Chamada HTTP PATCH para o ponto de extremidade -https://graph.microsoft.com:443/v1.0/me/drive/items/{workbookID}/workbook/worksheets/{worksheetName}

Entrada obrigatória

Os parâmetros a seguir são enviados como corpo da solicitação

1. Workbook ID - O ID da pasta de trabalho
2. Worksheet Name - Título da planilha
3. Worksheet Position - A posição baseada em zero da planilha dentro da pasta de trabalho
4. New Worksheet name - Novo título da planilha

Extrator de saída obrigatório

1. sheetID: Identificador exclusivo da pasta de trabalho que será usada para executar as outras tarefas
2. sheetName: O nome de exibição da planilha.
3. sheetPosition: A posição baseada em zero da planilha dentro da pasta de trabalho.

6) Obter dados de uma célula específica

Objetivo

Esse conector buscará os dados das planilhas de uma pasta de trabalho com base no WorkbookID, no nome da planilha, no índice de linha e no índice de coluna fornecidos como entrada. A resposta da API será os dados do valor da célula fornecida.

Ponto final

Chamada HTTP GET para o ponto de extremidade -https://graph.microsoft.com:443/v1.0/me/drive/items/{workbookID}/workbook/worksheets/{worksheetName}/cell(row={row index},column={column index})

Entrada obrigatória

A seguir estão os parâmetros de URL que devem ser passados

1. Workbook Id - ID da pasta de trabalho
2. Worksheet Name (Nome da planilha) - Título da planilha
3. Row Index - Número da linha da célula a ser recuperada
4. Column Index - Número da coluna da célula a ser recuperada

Extrator de saída obrigatório

Esse conector retorna o valor da célula do índice de linha e coluna fornecido.

7) Obter dados do intervalo da planilha

Objetivo

Esse conector buscará os dados das planilhas de uma pasta de trabalho com base no WorkbookID, no Nome da planilha, no Intervalo inicial e no Intervalo final fornecidos como entrada. A resposta da API será os dados do intervalo fornecido.

Ponto final

Chamada HTTP GET para o ponto de extremidade -https://graph.microsoft.com:443/v1.0/me/drive/items/{workbookID}/workbook/worksheets/{worksheetName}/range(address='{start range}:{end range}')

Entrada obrigatória

A seguir estão os parâmetros de URL que devem ser passados

1. Workbook Id - ID da pasta de trabalho
2. Worksheet name (Nome da planilha) - Título da planilha
3. Start range - Intervalo inicial
4. End range - Intervalo final

Extrator de saída obrigatório

Esse conector retorna todos os valores de célula dentro do intervalo fornecido.

8) Atualizar valores por intervalo

Objetivo

Os usuários podem passar o ID da pasta de trabalho, o nome da planilha, o intervalo inicial, o intervalo final e os valores a serem atualizados como entrada e o Tulip atualizará os valores do intervalo com o intervalo fornecido. A resposta da API será os valores de intervalo atualizados.

Ponto final

Chamada HTTP PATCH para o ponto de extremidade -https://graph.microsoft.com:443/v1.0/me/drive/items/{workbookID}/workbook/worksheets/{worksheetName}/range(address='{start range}:{end range}')

Entrada obrigatória

A seguir estão os parâmetros de URL que devem ser passados

1. Workbook Id - ID da pasta de trabalho
2. Worksheet name (Nome da planilha) - Título da planilha
3. Start range - Intervalo inicial
4. End range - Intervalo final
5. Valores de cada célula dentro do intervalo fornecido

Extrator de saída necessário

Não precisamos de nenhum extrator de saída.

9) Criar uma tabela na planilha

Objetivo

1. Os usuários podem passar o ID da pasta de trabalho, o nome da planilha, o endereço da planilha e os cabeçalhos como entrada e o Tulip criará uma nova tabela com o nome da tabela. A resposta da API será os metadados e várias propriedades da tabela.
2. Isso pode ser usado posteriormente para buscar e atualizar dados das planilhas.
3. As informações extraídas da API do Microsoft Graph V1.0 podem ser usadas em aplicativos Tulip, tabelas Tulip ou variáveis Tulip que seriam canalizadas para outras funções do conector.

Ponto final

Chamada HTTP POST para o endpoint https://graph.microsoft.com:443/v1.0/me/drive/items/{itemID}/workbook/worksheets/add

Entrada obrigatória

Os parâmetros a seguir são enviados como o corpo da solicitação

1. Workbook ID - O ID da pasta de trabalho
2. Worksheet Name - Título da planilha
3. Address - Endereço ou nome do objeto de intervalo que representa a fonte de dados. Se o endereço não contiver um nome de planilha, será usada a planilha ativa no momento.
4. hasHeaders - Valor booleano que indica se os dados que estão sendo importados têm rótulos de coluna. Se a fonte não contiver cabeçalhos (ou seja, quando essa propriedade estiver definida como false), o Excel gerará automaticamente um cabeçalho deslocando os dados para baixo em uma linha

Extrator de saída obrigatória

Retorna os valores de metadados da tabela recém-criada.

10) Adicionar uma nova linha em uma tabela

Objetivo

Os usuários podem passar um ID de pasta de trabalho, um nome de tabela e valores de linha como entrada e a Tulip criará uma nova linha com os valores de linha fornecidos. A resposta da API será os valores de linha criados na tabela.

Ponto final

Chamada HTTP POST para o ponto de extremidade https://graph.microsoft.com:443/v1.0/me/drive/items/{workbookID}/workbook/tables/{tablename}/rows/add

Entrada obrigatória

Os parâmetros a seguir são enviados como corpo da solicitação

1. Workbook ID - O ID da pasta de trabalho
2. Worksheet Name - Título da planilha
3. Valores de linha

Extractor de saída obrigatório

Retorna os valores de linha da linha recém-criada.

11) Limpar os dados da planilha

Objetivo

Os usuários podem passar o ID da pasta de trabalho, o nome da planilha, o intervalo inicial e o intervalo final como entrada e o Tulip limpará os valores das células com base no intervalo fornecido.

Ponto final

Chamada HTTP POST para o ponto de extremidade https://graph.microsoft.com:443/v1.0/me/drive/items/{workbookID}/workbook/worksheet/{worksheetName}/range(address='{start range}:{end range}')/clear

Entrada obrigatória

Os parâmetros a seguir são enviados como o corpo da solicitação

1. Workbook ID - O ID da pasta de trabalho
2. Worksheet Name - Título da planilha
3. Intervalo inicial
4. Intervalo final

Leitura adicional

Confira mais informações sobre os conectores da Microsoft

• Conector do Microsoft Calendar
• Conector do Microsoft Outlook
• Conector do Microsoft Teams