Коннектор Microsoft Excel

::: (информация) () Чтобы скачать приложение, посетите: Библиотека:::

Microsoft Excel Connector

Интеграция с Microsoft O365 Worksheet V1.0 Api

Введение

Microsoft Excel Worksheets API позволяет пользователям создавать, читать и редактировать листы Microsoft excel с соответствующим доступом, установленным для их учетных записей Office365. Цель этого коннектора - интегрировать Tulip с Microsoft, используя Graph API Microsoft (v1.0) с помощью HTTP-коннекторов, и предоставить нашим клиентам готовый коннектор, который можно импортировать в их экземпляр.

Назначение

В этом документе будут описаны различные функции коннектора, которые могут быть созданы путем выполнения HTTP-вызовов к Microsoft Graph API(v1.0) для взаимодействия с рабочим листом M365 Excel, чтобы продемонстрировать различные действия чтения и записи на рабочем листе, которые могут быть использованы для различных сценариев использования.

Документация API

Документация Microsoft Graph API

Предварительные требования

1. Создайте учетную запись в Microsoft O365 и настройте учетные данные OAuth 2.0 в Microsoft Entra ID.
2. Зарегистрируйте API с необходимыми диапазонами на портале Microsoft. Azure - Entra ID

Видео о настройке коннектора:

Детали подключения Tulip

Следующую информацию необходимо настроить в Tulip's

Connectors.

1. Работает на: хосте облачного коннектора
2. Хост: graph.microsoft.com
3. Порт:443
4. TLS: Да

OAuth 2: получение маркера доступа для взаимодействия с Graph API Microsoft.

Функции коннектора

1) Получить сведения об одном диске

Назначение

Этот коннектор будет получать все элементы с одного диска.

Конечная точка

HTTP POST вызов конечной точки -https://graph.micrsoft.com:443/v1.0/me/drive/root/children

Требуемый ввод

Входы не требуются

Требуемый выходной экстрактор

1. SheetID: Уникальный идентификатор рабочей книги, которая будет использоваться для выполнения других задач.
2. CreatedAt: Дата и время создания рабочей книги.
3. LastModified: Дата и время последнего изменения рабочей книги.
4. SheetName (Имя листа): Имя рабочей книги.
5. SpreadSheetURL: URL-адрес рабочей книги.

2) Получить все рабочие листы в рабочей книге

Назначение

Этот коннектор получает все рабочие листы рабочей книги, передавая идентификатор рабочей книги.

Конечная точка

HTTP GET к конечной точке -https://graph.microsoft.com:443/v1.0/me/drive/items/{workbookID}/workbook/worksheets

Требуемый ввод

Ниже перечислены параметры URL, которые необходимо передать

1. Идентификатор рабочей книги

Требуемый выходной экстрактор

1. sheetId: Уникальный идентификатор электронной таблицы, которая будет использоваться для выполнения других задач.
2. sheetName:отображаемое имя рабочего листа.
3. sheetPosition: нулевая позиция рабочего листа в рабочей книге.
4. sheetVisibility: Видимость рабочего листа. Возможные значения: Visible, Hidden, VeryHidden.

3) Получить метаданные рабочего листа

Назначение

Этот коннектор получает данные из идентификатора рабочей книги и названия рабочего листа.

Конечная точка

HTTP GET вызов конечной точки https://graph.microsoft.com:443/v1.0/me/drive/items/{workbookID}/workbook/worksheets/{worksheetName}/.

Требуемый ввод

Ниже перечислены параметры URL, которые необходимо передать

1. Идентификатор рабочей книги
2. Имя рабочего листа

Требуемый выходной экстрактор

1. sheetId: Уникальный идентификатор электронной таблицы, которая будет использоваться для выполнения других задач.
2. sheetName:отображаемое имя рабочего листа.
3. sheetPosition: нулевая позиция рабочего листа в рабочей книге.
4. sheetVisibility: Видимость рабочего листа. Возможные значения: Видимый, Скрытый, Очень скрытый.

4) Создание нового рабочего листа

Назначение .

1. Пользователи могут передать ID рабочей книги и имя рабочего листа в качестве входных данных, и Tulip создаст новый рабочий лист с указанным именем листа. Ответом API будут метаданные и различные свойства рабочего листа. Это может быть использовано для получения и обновления данных из рабочих листов.
2. Информация, полученная из Microsoft Graph V1.0 API, может быть использована в приложениях Tulip, таблицах Tulip или переменных Tulip, которые будут переданы в другие функции коннектора.

Конечная точка

HTTP POST вызов конечной точки https://graph.microsoft.com:443/v1.0/me/drive/items/{workbookID}/workbook/worksheets/add

Необходимые входные данные

Ниже перечислены параметры, которые отправляются в теле запроса

1. Идентификатор рабочей книги - идентификатор рабочей книги
2. Название рабочей книги - Название рабочей книги

Требуемый выходной экстрактор

1. WorksheetId: Уникальный идентификатор электронной таблицы, которая будет использоваться для выполнения других задач.
2. spreadsheetURL: URL-адрес только что созданной электронной таблицы.
3. Дополнительные параметры, которые возвращаются вместе с ответом, могут быть включены в выходные параметры.

5) Обновление свойств рабочего листа

Назначение .

Пользователи могут передать ID рабочей книги, имя старого рабочего листа, позицию рабочего листа и имя нового рабочего листа в качестве входных данных, и Tulip обновит рабочий лист с указанным именем листа. Ответом API будут метаданные и различные свойства рабочего листа. В дальнейшем это можно использовать для получения и обновления данных из электронных таблиц.

Конечная точка

HTTP PATCH вызов конечной точки -https://graph.microsoft.com:443/v1.0/me/drive/items/{workbookID}/workbook/worksheets/{worksheetName}

Необходимые входные данные

Ниже перечислены параметры, которые отправляются в теле запроса

1. Идентификатор рабочей книги - Идентификатор рабочей книги
2. Название рабочего листа - Название рабочего листа
3. Позиция рабочего листа - нулевая позиция рабочего листа в рабочей книге
4. Имя нового рабочего листа - название нового рабочего листа

Требуемый выходной экстрактор

1. sheetID: Уникальный идентификатор рабочей книги, которая будет использоваться для выполнения других задач
2. sheetName: Отображаемое имя рабочего листа.
3. sheetPosition: нулевая позиция рабочего листа в рабочей книге.

6) Получение данных конкретной ячейки

Назначение

Этот коннектор получает данные из рабочих листов рабочей книги на основе предоставленных WorkbookID, Worksheet Name, Row index и Column index в качестве входных данных. Ответом API будут данные предоставленного значения ячейки.

Конечная точка

HTTP GET вызов конечной точки -https://graph.microsoft.com:443/v1.0/me/drive/items/{workbookID}/workbook/worksheets/{worksheetName}/cell(row={индекс строки},column={индекс столбца})

Требуемый ввод

Ниже перечислены параметры URL, которые необходимо передать

1. Workbook Id - идентификатор рабочей книги
2. Имя рабочего листа - название рабочего листа
3. Индекс строки - номер строки ячейки, которую необходимо извлечь
4. Индекс столбца - номер столбца извлекаемой ячейки

Экстрактор требуемого вывода

Этот соединитель возвращает значение ячейки с указанным индексом строки и столбца.

7) Получение данных диапазона рабочего листа

Назначение

Этот коннектор получает данные из рабочих листов рабочей книги на основе предоставленных WorkbookID, Worksheet Name, Start Range и End Range в качестве входных данных. Ответом API будут данные предоставленного диапазона.

Конечная точка

HTTP GET вызов конечной точки -https://graph.microsoft.com:443/v1.0/me/drive/items/{workbookID}/workbook/worksheets/{worksheetName}/range(address='{start range}:{end range}')

Требуемый ввод

Ниже перечислены параметры URL, которые необходимо передать

1. Id рабочей книги - идентификатор рабочей книги
2. Название рабочего листа - Название рабочего листа
3. Начальный диапазон - Начальный диапазон
4. Конечный диапазон - конечный диапазон

Экстрактор требуемого вывода

Этот соединитель возвращает все значения ячеек в указанном диапазоне.

8) Обновление значений по диапазону

Назначение

Пользователи могут передать ID рабочей книги, имя рабочего листа, начальный диапазон, конечный диапазон и значения для обновления в качестве входных данных, и Tulip обновит значения диапазона по предоставленному диапазону. Ответом API будут обновленные значения диапазона.

Конечная точка

HTTP PATCH вызов конечной точки -https://graph.microsoft.com:443/v1.0/me/drive/items/{workbookID}/workbook/worksheets/{worksheetName}/range(address='{start range}:{end range}')

Требуемый ввод

Ниже перечислены параметры URL, которые необходимо передать

1. Id рабочей книги - идентификатор рабочей книги
2. Название рабочего листа - Название рабочего листа
3. Начальный диапазон - Начальный диапазон
4. Конечный диапазон - Конечный диапазон
5. Значения каждой ячейки в указанном диапазоне

Необходимый экстрактор вывода

Нам не требуется никакой экстрактор вывода.

9) Создание таблицы в рабочем листе

Назначение

1. Пользователи могут передать ID рабочей книги, имя рабочего листа, адрес рабочего листа и заголовки в качестве входных данных, и Tulip создаст новую таблицу с именем таблицы. Ответом API будут метаданные и различные свойства таблицы.
2. В дальнейшем это можно использовать для получения и обновления данных из электронных таблиц.
3. Информация, полученная из Microsoft Graph V1.0 API, может быть использована в приложениях Tulip, таблицах Tulip или переменных Tulip, которые будут переданы в другие функции коннектора.

Конечная точка

HTTP POST вызов конечной точки https://graph.microsoft.com:443/v1.0/me/drive/items/{itemID}/workbook/worksheets/add

Необходимые входные данные

Ниже перечислены параметры, которые передаются в теле запроса

1. Идентификатор рабочей книги - идентификатор рабочей книги
2. Название рабочей книги - Название рабочей книги
3. Адрес - Адрес или имя объекта диапазона, представляющего источник данных. Если адрес не содержит имени листа, используется активный в данный момент лист.
4. hasHeaders - булево значение, указывающее, есть ли в импортируемых данных метки столбцов. Если источник не содержит заголовков (т. е. это свойство имеет значение false), Excel автоматически сгенерирует заголовок, сдвинув данные на одну строку вниз.

Экстрактор требуемого вывода

Возвращает значения метаданных только что созданной таблицы.

10) Добавление новой строки в таблицу

Назначение

Пользователи могут передать ID рабочей книги, имя таблицы и значения строк в качестве входных данных, и Tulip создаст новую строку с указанными значениями строк. Ответом API будут созданные значения строк в таблице.

Конечная точка

HTTP POST вызов конечной точки https://graph.microsoft.com:443/v1.0/me/drive/items/{workbookID}/workbook/tables/{tablename}/rows/add

Необходимые входные данные

Ниже перечислены параметры, которые отправляются в теле запроса

1. Идентификатор рабочей книги - Идентификатор рабочей книги
2. Название рабочей книги - Название рабочей книги
3. Значения строк

Требуемый выходной экстрактор

Возвращает значения строк вновь созданной строки.

11) Очистить данные рабочего листа

Назначение

Пользователи могут передать ID рабочей книги, имя рабочего листа, начальный и конечный диапазон в качестве входных данных, и Tulip очистит значения ячеек на основе заданного диапазона.

Конечная точка

HTTP POST вызов конечной точки https://graph.microsoft.com:443/v1.0/me/drive/items/{workbookID}/workbook/worksheet/{worksheetName}/range(address='{start range}:{end range}')/clear

Требуемый ввод

Ниже перечислены параметры, которые передаются в теле запроса

1. Идентификатор рабочей книги - Идентификатор рабочей книги
2. Worksheet Name - Название рабочего листа
3. Начальный диапазон
4. Конечный диапазон

Дальнейшее чтение

Ознакомьтесь с дополнительной информацией о коннекторах Microsoft

• Коннектор календаря Microsoft
• Коннектор Microsoft Outlook
• Коннектор Microsoft Teams