- Impresión
::: (info) () Para descargar la aplicación, visite: Biblioteca:::
Conector Microsoft Excel
Integración con Microsoft O365 Worksheet V1.0 Api
Introducción
Microsoft Excel Worksheets API permite a los usuarios crear, leer y editar hojas de Microsoft Excel con el derecho de acceso a sus cuentas de Office365. El objetivo de este conector es integrar Tulip con Microsoft utilizando Microsoft Graph API(v1.0) utilizando conectores HTTP y proporcionar a nuestros clientes un conector listo para usar que se puede importar en su instancia.
Propósito
Este documento resaltará diferentes funciones del conector que pueden ser construidas haciendo llamadas HTTP al Graph API(v1.0) de Microsoft para interactuar con la hoja de cálculo Excel M365 para mostrar varias acciones de lectura y escritura en la hoja de cálculo que podrían ser aprovechadas para varios casos de uso.
Documentación de la API
Documentación de Microsoft Graph API
Requisitos previos
- Crear una cuenta en Microsoft O365 y configurar las credenciales OAuth 2.0 en Microsoft Entra ID.
- Registrar API con los alcances requeridos en el portal de Microsoft. Azure - Entra ID
Vídeo de configuración del conector:
Tulip Connection Details
La siguiente información necesitaría ser configurada en Tulip's
Conectores.
- Ejecutando en: Cloud Connector Host
- Host: graph.microsoft.com
- Puerto:443
- TLS: Sí
OAuth 2: Para obtener el token de acceso para comunicarse con la API Graph de Microsoft
Funciones del conector
1) Obtener detalles de una unidad
Propósito
Este conector obtendrá todos los elementos de una unidad.
Punto final
Llamada HTTP POST al punto final -https://graph.micrsoft.com:443/v1.0/me/drive/root/children
Entrada requerida
No se requieren entradas
Salida requerida Extractor
- SheetID: Identificador único del Libro de Trabajo que se utilizará para realizar las demás tareas.
- CreatedAt: Fecha y hora de creación del libro de trabajo.
- LastModified: La fecha y hora de la última modificación del libro de trabajo.
- NombreHoja: El nombre del libro de trabajo.
- SpreadSheetURL: La URL del libro de trabajo.
2) Obtener todas las hojas de cálculo de un libro de trabajo
Propósito
Este conector obtendrá todas las hojas de trabajo de un libro de trabajo pasando el workbookID.
Punto final
HTTP GET al punto final -https://graph.microsoft.com:443/v1.0/me/drive/items/{workbookID}/workbook/worksheets
Entrada obligatoria
A continuación se indican los parámetros de URL que deben introducirse
- Id. del libro de trabajo
Salida requerida Extractor
- sheetId: Identificador único de la hoja de cálculo que se utilizará para realizar las demás tareas.
- sheetName:Nombre para mostrar de la hoja de cálculo.
- sheetPosition:La posición en base cero de la hoja de cálculo dentro del libro de trabajo.
- sheetVisibility: La visibilidad de la hoja de cálculo. Los valores posibles son Visible, Oculto, MuyOculto.
3) Obtener metadatos de la hoja de trabajo
Propósito
Este conector obtendrá los datos de WorkbookID y Worksheet Name.
Punto final
Llamada HTTP GET al punto final https://graph.microsoft.com:443/v1.0/me/drive/items/{workbookID}/workbook/worksheets/{worksheetName}/
Entrada obligatoria
A continuación se indican los parámetros de URL que deben introducirse
- ID del libro de trabajo
- Nombre de la hoja de trabajo
Salida requerida Extractor
- sheetId: Identificador único de la hoja de cálculo que se utilizará para realizar las demás tareas.
- sheetName:Nombre de la hoja de cálculo.
- sheetPosition:La posición en base cero de la hoja de cálculo dentro del libro de trabajo.
- sheetVisibility: La visibilidad de la hoja de trabajo. Los valores posibles son: Visible, Oculto, MuyOculto.
4) Creación de una nueva hoja de cálculo
Propósito
- Los usuarios pueden pasar un ID de libro de trabajo y un nombre de hoja de trabajo como entrada y Tulip creará una nueva hoja de trabajo con el nombre de hoja proporcionado. La respuesta de la API serán los metadatos y varias propiedades de la hoja de trabajo. Esto se puede utilizar para obtener y actualizar los datos de las hojas de trabajo.
- La información se extrae de la API de Microsoft Graph V1.0 y se puede utilizar en aplicaciones de Tulip, tablas de Tulip o variables de Tulip que se canalizarán a otras funciones del conector.
Punto final
Llamada HTTP POST al punto final https://graph.microsoft.com:443/v1.0/me/drive/items/{workbookID}/workbook/worksheets/add
Entrada requerida
Los siguientes son los parámetros que se envían como cuerpo de la solicitud
- ID del libro de trabajo - ID del libro de trabajo
- Nombre de la hoja de trabajo - Título de la hoja de trabajo
Salida requerida Extractor
- WorksheetId: Identificador único de la SpreadSheet que se utilizará para realizar las demás tareas .
- spreadsheetURL: La URL de la Hoja de Cálculo recién creada.
- Los parámetros adicionales que se devuelven con la respuesta pueden incluirse como parte de los parámetros de salida.
5) Actualización de las propiedades de la hoja de cálculo
Propósito
Los usuarios pueden pasar un ID de libro de trabajo, un nombre de hoja de cálculo antigua, una posición de hoja de cálculo y un nombre de hoja de cálculo nueva como entrada y Tulip actualizará la hoja de cálculo con el nombre de hoja proporcionado. La respuesta de la API serán los metadatos y varias propiedades de la hoja de trabajo. Esto se puede utilizar para obtener y actualizar los datos de las hojas de cálculo.
Punto final
Llamada HTTP PATCH al punto final -https://graph.microsoft.com:443/v1.0/me/drive/items/{workbookID}/workbook/worksheets/{worksheetName}
Entrada requerida
Los siguientes son los parámetros que se envían como cuerpo de la solicitud
- ID del libro de trabajo - ID del libro de trabajo
- Nombre de la hoja de trabajo - Título de la hoja de trabajo
- Posición de la hoja de trabajo: posición basada en cero de la hoja de trabajo dentro del libro de trabajo
- Nombre de la nueva hoja de trabajo- Título de la nueva hoja de trabajo
Extractor de salida requerido
- sheetID: Identificador único del Libro de Trabajo que se utilizará para realizar las demás tareas
- sheetName: El nombre para mostrar de la hoja de trabajo.
- sheetPosition:La posición en base cero de la hoja de trabajo dentro del libro de trabajo.
6) Obtener datos de una celda específica
Propósito
Este conector obtendrá los datos de las hojas de cálculo de un libro de trabajo basándose en WorkbookID, Worksheet Name, Row index, y Column index proporcionados como entrada. La respuesta de la API serán los datos del valor de la celda proporcionada.
Punto final
Llamada HTTP GET al punto final -https://graph.microsoft.com:443/v1.0/me/drive/items/{workbookID}/workbook/worksheets/{worksheetName}/cell
(row={índice de fila},column={índice de columna})
Entrada obligatoria
A continuación se indican los parámetros de URL que deben introducirse
- ID del libro de trabajo
- Nombre de la hoja de trabajo: título de la hoja de trabajo
- Índice de fila: número de fila de la celda que debe recuperarse.
- Column Index- Número de columna de la celda a recuperar
Extractor de Salida Requerido
Este conector devuelve el valor de la celda del índice de fila y columna proporcionado.
7) Obtener datos de rango de hoja de cálculo
Propósito
Este conector obtendrá los datos de las hojas de cálculo de un libro de trabajo basándose en WorkbookID, Worksheet Name, Start Range y End Range. La respuesta de la API serán los datos del rango proporcionado.
Punto final
Llamada HTTP GET al punto final -https://graph.microsoft.com:443/v1.0/me/drive/items/{workbookID}/workbook/worksheets/{worksheetName}/range
(address='{intervalo inicial}:{intervalo final}')
Entrada obligatoria
A continuación se indican los parámetros de URL que deben introducirse
- ID del libro de trabajo
- Nombre de la hoja de trabajo: título de la hoja de trabajo
- Rango inicial- Rango inicial
- End range- Rango final
Extractor de salida requerido
Este conector devuelve todos los valores de celda dentro del rango proporcionado.
8) Actualizar valores por Rango
Propósito
Los usuarios pueden pasar un ID de libro de trabajo, nombre de hoja de cálculo, rango inicial, rango final y valores a actualizar como entrada y Tulip actualizará los valores de rango con el rango proporcionado. La respuesta de la API serán los valores actualizados del rango.
Punto final
Llamada HTTP PATCH al punto final -https://graph.microsoft.com:443/v1.0/me/drive/items/{workbookID}/workbook/worksheets/{worksheetName}/range
(address='{intervalo inicial}:{intervalo final}')
Entrada obligatoria
A continuación se indican los parámetros de URL que deben introducirse
- ID del libro de trabajo
- Nombre de la hoja de trabajo: título de la hoja de trabajo
- Rango inicial- Rango inicial
- End range- Rango final
- Valores de cada celda dentro del rango proporcionado
Extractor de salida requerido
No requerimos ningún extractor de salida.
9) Crear una tabla en la hoja de cálculo
Propósito
- Los usuarios pueden pasar el ID del libro de trabajo, el nombre de la hoja de trabajo, la dirección de la hoja de trabajo y los encabezados como entrada y Tulip creará una nueva tabla con el nombre de la tabla. La respuesta de la API serán los metadatos y varias propiedades de la tabla.
- Esto se puede utilizar para obtener y actualizar los datos de las hojas de cálculo.
- La información se extrae de la API de Microsoft Graph V1.0 y puede ser utilizada en aplicaciones Tulip, tablas Tulip, o variables Tulip que se canalizan en otras funciones del conector.
Punto final
Llamada HTTP POST al punto final https://graph.microsoft.com:443/v1.0/me/drive/items/{itemID}/workbook/worksheets/add
Entrada requerida
Los siguientes son los parámetros que se envían como cuerpo de la solicitud
- ID del libro de trabajo - ID del libro de trabajo
- Nombre de la hoja de trabajo - Título de la hoja de trabajo
- Dirección-Dirección o nombre del objeto de rango que representa la fuente de datos. Si la dirección no contiene un nombre de hoja, se utiliza la hoja actualmente activa.
- hasHeaders-Valor booleano que indica si los datos que se están importando tienen etiquetas de columna. Si la fuente no contiene encabezados (es decir, cuando esta propiedad es falsa), Excel generará automáticamente un encabezado desplazando los datos una fila hacia abajo.
Extractor de salida obligatorio
Devuelve los valores de metadatos de la tabla recién creada.
10) Añadir una nueva fila en una tabla
Propósito
Los usuarios pueden pasar un ID de libro de trabajo, un nombre de tabla y valores de fila como entrada y Tulip creará una nueva fila con los valores de fila proporcionados. La respuesta de la API serán los valores de la fila creada en la tabla.
Punto final
Llamada HTTP POST al punto final https://graph.microsoft.com:443/v1.0/me/drive/items/{workbookID}/workbook/tables/{tablename}/rows/add
Entrada obligatoria
Los siguientes son los parámetros que se envían como cuerpo de la solicitud
- ID del libro de trabajo - ID del libro de trabajo
- Nombre de la hoja de trabajo - Título de la hoja de trabajo
- Valores de fila
Salida Requerida Extractor
Devuelve los valores de fila de la nueva fila creada.
11) Borrar los datos de la hoja de trabajo
Propósito
Los usuarios pueden introducir el ID del libro de trabajo, el nombre de la hoja de trabajo, el rango inicial y el rango final y Tulip borrará los valores de las celdas basándose en el rango indicado.
Punto final
Llamada HTTP POST al punto final https://graph.microsoft.com:443/v1.0/me/drive/items/{workbookID}/workbook/worksheet/{worksheetName}/range
(address='{start range}:{end range}')/clear
Entrada obligatoria
Los siguientes son los parámetros que se envían como cuerpo de la solicitud
- ID del libro de trabajo - ID del libro de trabajo
- Nombre de la hoja de trabajo - Título de la hoja de trabajo
- Rango inicial
- Rango Final
Más información
Más información sobre Microsoft Connectors