Skip to main content

Microsoft Excel Connector

Microsoft Excel Parse and build .xlsx files (spreadsheets)

Connections

Microsoft Excel OAuth 2.0

Connect to Microsoft Excel using OAuth 2.0

This connection uses OAuth 2.0, a common authentication mechanism for integrations. Read about how OAuth 2.0 works here.

InputCommentsDefault
ScopesMicrosoft Excel Scopes.Files.ReadWrite.All Sites.Read.All Sites.ReadWrite.All offline_access
Client IDGet this value from your App Registration in the Azure Portal
Client SecretGet this value from your App Registration in the Azure Portal
SourceThe source from which the workbooks will be listed.

Actions

Build Spreadsheet

Creates a buffer containing a spreadsheet made from a 2D JavaScript array,

InputCommentsDefault
Spreadsheet DataFor each item, provide a list of items representing the items to be inserted.
[
[
1,
2,
3,
4,
5
],
[
"foo",
"bar",
"2014-02-19T14:30:00.000Z",
"0.3"
],
[
true,
false,
null,
"sheetjs"
]
]
File NameProvide a string value for the name of the file.
Create OptionsHere you can provide several configuration options for turning the array into a spreadsheet. For more information on possible configurations, see the documentation for the node library this component was built with. https://www.npmjs.com/package/node-xlsx
{
"!cols": [
{
"wch": 6
},
{
"wch": 7
},
{
"wch": 10
},
{
"wch": 20
}
]
}

Build Spreadsheet with Multiple Sheets

Creates a buffer containing multiple spreadsheets made from a 3D JavaScript array.

InputCommentsDefault
Spreadsheet DataFor each item, provide a list with a list items representing the cells to be inserted.
[
[
[
4,
5,
6
],
[
7,
8,
9,
10
],
[
11,
12,
13,
14
],
[
"baz",
null,
"qux"
]
],
[
[
1,
2,
3,
4,
5
],
[
"foo",
"bar",
"2014-02-19T14:30:00.000Z",
"0.3"
],
[
true,
false,
null,
"sheetjs"
]
]
]
Sheet NamesProvide a string value for the name of the file.
Structured Sheet NamesUse this input if you want to provide a JSON Array of sheetNames instead of using the default sheetNames input. Please note that this input takes priority over the sheetNames input.
Create OptionsHere you can provide several configuration options for turning the array into a spreadsheet. For more information on possible configurations, see the documentation for the node library this component was built with. https://www.npmjs.com/package/node-xlsx
{
"!cols": [
{
"wch": 6
},
{
"wch": 7
},
{
"wch": 10
},
{
"wch": 20
}
]
}

Clear Cell Range

Clear range values such as format, fill, and border.

InputCommentsDefault
Connection
Drive or Site IDThe ID of the OneDrive or SharePoint site to list workbooks from.
Workbook IDThe ID of the workbook that contains the worksheet to clear cells from.
Worksheet IDThe ID or name of the worksheet to clear cells from.
AddressThe address of the range to update.
Apply ToDetermines the type of clear action.
Debug RequestEnabling this flag will log out the current request.false

Create Column

Creates a Column object inside a worksheet table.

InputCommentsDefault
Connection
Drive or Site IDThe ID of the OneDrive or SharePoint site to list workbooks from.
Workbook IDThe ID of the workbook that contains the worksheet to create the column in.
Worksheet IDThe ID or name of the worksheet to create the column in.
Table IDThe ID or name of the table to create the column in.
ValuesA two-dimensional array of unformatted values of the table column.
Column IndexSpecifies the relative position of the new column. The previous column at this position is shifted to the right. The index value should be equal to or less than the last column's index value, so it can't be used to append a column at the end of the table. Zero-indexed.
Debug RequestEnabling this flag will log out the current request.false

Create Multiple Rows

Adds rows to the end of a table.

InputCommentsDefault
Connection
Drive or Site IDThe ID of the OneDrive or SharePoint site to list workbooks from.
Workbook IDThe ID of the workbook that contains the worksheet to create the row in.
Worksheet IDThe ID or name of the worksheet to create the row in.
Table IDThe ID or name of the table to create the row in.
ValuesThe values to update in the row.
Row IndexSpecifies the relative position of the new row. If null, the addition happens at the end. Any rows below the inserted row are shifted downwards. Zero-indexed.
Debug RequestEnabling this flag will log out the current request.false

Create Row

Creates a row object inside a worksheet table.

InputCommentsDefault
Connection
Drive or Site IDThe ID of the OneDrive or SharePoint site to list workbooks from.
Workbook IDThe ID of the workbook that contains the worksheet to create the row in.
Worksheet IDThe ID or name of the worksheet to create the row in.
Table IDThe ID or name of the table to create the row in.
ValuesThe values to update in the row.
Row IndexSpecifies the relative position of the new row. If null, the addition happens at the end. Any rows below the inserted row are shifted downwards. Zero-indexed.
Debug RequestEnabling this flag will log out the current request.false

Create Table

Creates a table object inside a worksheet.

InputCommentsDefault
Connection
Drive or Site IDThe ID of the OneDrive or SharePoint site to list workbooks from.
Workbook IDThe ID of the workbook that contains the worksheet to create the table in.
Worksheet IDThe ID of the worksheet to create the table in.
AddressAddress or name of the range object representing the data source. If the address doesn't contain a sheet name, the currently active sheet is used.
Has HeadersBoolean value that indicates whether the data being imported has column labels. If the source doesn't contain headers (when this property set to false), Excel generates header shifting the data down by one row.false
Debug RequestEnabling this flag will log out the current request.false

Create Worksheet

Creates a worksheet object inside a workbook.

InputCommentsDefault
Connection
Drive or Site IDThe ID of the OneDrive or SharePoint site to list workbooks from.
Workbook IDThe ID of the workbook that contains the worksheet to update.
Worksheet NameThe display name of the worksheet.
Debug RequestEnabling this flag will log out the current request.false

Delete Cell Range

Deletes the cells associated with the range.

InputCommentsDefault
Connection
Drive or Site IDThe ID of the OneDrive or SharePoint site to list workbooks from.
Workbook IDThe ID of the workbook that contains the worksheet to delete cells from.
Worksheet IDThe ID or name of the worksheet to delete cells from.
AddressThe address of the range to update.
ShiftSpecifies which way to shift the cells.
Debug RequestEnabling this flag will log out the current request.false

Delete Column

Deletes a column object from a worksheet table.

InputCommentsDefault
Connection
Drive or Site IDThe ID of the OneDrive or SharePoint site to list workbooks from.
Workbook IDThe ID of the workbook that contains the worksheet to delete the column from.
Worksheet IDThe ID or name of the worksheet to delete the column from.
Table IDThe ID or name of the table to delete the column from.
Column IndexThe id or name of the column to delete.
Debug RequestEnabling this flag will log out the current request.false

Delete Table

Deletes a table object from a worksheet.

InputCommentsDefault
Connection
Drive or Site IDThe ID of the OneDrive or SharePoint site to list workbooks from.
Workbook IDThe ID of the workbook that contains the worksheet to delete the table from.
Worksheet IDThe ID or name of the worksheet to delete the table from.
Table IDThe ID or name of the table to delete.
Debug RequestEnabling this flag will log out the current request.false

Delete Worksheet

Deletes a worksheet from a workbook.

InputCommentsDefault
Connection
Drive or Site IDThe ID of the OneDrive or SharePoint site to list workbooks from.
Workbook IDThe ID of the workbook that contains the worksheet to delete.
Worksheet IDThe ID of the worksheet to delete.
Debug RequestEnabling this flag will log out the current request.false

Get Cell

Retrieves a cell from a worksheet.

InputCommentsDefault
Connection
Drive or Site IDThe ID of the OneDrive or SharePoint site to list workbooks from.
Workbook IDThe ID of the workbook that contains the worksheet to list cells from.
Worksheet IDThe ID or name of the worksheet to list cells from.
Row IndexThe number of the row to retrieve.
Column IndexThe number of the column to retrieve.
Debug RequestEnabling this flag will log out the current request.false

Get Cell Range

Retrieve the properties and relationships of range object.

InputCommentsDefault
Connection
Drive or Site IDThe ID of the OneDrive or SharePoint site to list workbooks from.
Workbook IDThe ID of the workbook that contains the worksheet to list cells from.
Worksheet IDThe ID or name of the worksheet to list cells from.
Debug RequestEnabling this flag will log out the current request.false

Get Column

Retrieves a column object from a worksheet table.

InputCommentsDefault
Connection
Drive or Site IDThe ID of the OneDrive or SharePoint site to list workbooks from.
Workbook IDThe ID of the workbook that contains the worksheet to list column from.
Worksheet IDThe ID or name of the worksheet to list column from.
Table IDThe ID or name of the table to list column from.
Column IndexThe id or name of the column to retrieve.
Debug RequestEnabling this flag will log out the current request.false

Get Table

Retrieves a table object from a worksheet.

InputCommentsDefault
Connection
Drive or Site IDThe ID of the OneDrive or SharePoint site to list workbooks from.
Workbook IDThe ID of the workbook that contains the worksheet to get the table from.
Worksheet IDThe ID or name of the worksheet to get the table from.
Table IDThe ID or name of the table to retrieve
Debug RequestEnabling this flag will log out the current request.false

Get Worksheet

Retrieves a worksheet object from a workbook.

InputCommentsDefault
Connection
Drive or Site IDThe ID of the OneDrive or SharePoint site to list workbooks from.
Workbook IDThe ID of the workbook to retrieve.
Worksheet IDThe ID or name of the worksheet to retrieve.
Debug RequestEnabling this flag will log out the current request.false

List Columns

Retrieve a list of columns from a worksheet table.

InputCommentsDefault
Connection
Drive or Site IDThe ID of the OneDrive or SharePoint site to list workbooks from.
Workbook IDThe ID of the workbook that contains the worksheet to list columns from.
Worksheet IDThe ID or name of the worksheet to list columns from.
Table IDThe ID or name of the table to list columns from.
Fetch AllSet to true to retrieve all results.false
ExpandRetrieves related resources.
FilterFilters results (rows).
FormatReturns the results in the specified media format.
Order ByOrders results.
SearchReturns results based on search criteria.
SelectFilters properties (columns).
SkipIndexes into a result set. Also used by some APIs to implement paging and can be used together with $top to manually page results.
Skip TokenRetrieves the next page of results from result sets that span multiple pages.
TopSets the page size of results.
Debug RequestEnabling this flag will log out the current request.false

List Rows

Retrieve a list of rows from a worksheet table.

InputCommentsDefault
Connection
Drive or Site IDThe ID of the OneDrive or SharePoint site to list workbooks from.
Workbook IDThe ID of the workbook that contains the worksheet to list rows from.
Worksheet IDThe ID or name of the worksheet to list rows from.
Table IDThe ID or name of the table to list rows from.
Fetch AllSet to true to retrieve all results.false
ExpandRetrieves related resources.
FilterFilters results (rows).
FormatReturns the results in the specified media format.
Order ByOrders results.
SearchReturns results based on search criteria.
SelectFilters properties (columns).
SkipIndexes into a result set. Also used by some APIs to implement paging and can be used together with $top to manually page results.
Skip TokenRetrieves the next page of results from result sets that span multiple pages.
TopSets the page size of results.
Debug RequestEnabling this flag will log out the current request.false

List Tables

Retrieve a list of tables from a worksheet.

InputCommentsDefault
Connection
Drive or Site IDThe ID of the OneDrive or SharePoint site to list workbooks from.
Workbook IDThe ID of the workbook that contains the worksheet to list tables from.
Worksheet IDThe ID or name of the worksheet to list tables from.
Fetch AllSet to true to retrieve all results.false
ExpandRetrieves related resources.
FilterFilters results (rows).
FormatReturns the results in the specified media format.
Order ByOrders results.
SearchReturns results based on search criteria.
SelectFilters properties (columns).
SkipIndexes into a result set. Also used by some APIs to implement paging and can be used together with $top to manually page results.
Skip TokenRetrieves the next page of results from result sets that span multiple pages.
TopSets the page size of results.
Debug RequestEnabling this flag will log out the current request.false

List Workbooks

Return a collection of Workbooks from either a OneDrive or SharePoint site.

InputCommentsDefault
Connection
PathThe path to the file or folder.
Drive or Site IDThe ID of the OneDrive or SharePoint site to list workbooks from.
List or Item IDThe ID of the list or item to retrieve.
Fetch AllSet to true to retrieve all results.false
ExpandRetrieves related resources.
SelectFilters properties (columns).
Skip TokenRetrieves the next page of results from result sets that span multiple pages.
TopSets the page size of results.
Order ByOrders results.
Debug RequestEnabling this flag will log out the current request.false

List Worksheets

Retrieve a list of worksheet objects.

InputCommentsDefault
Connection
Drive or Site IDThe ID of the OneDrive or SharePoint site to list workbooks from.
Workbook IDThe ID of the workbook to retrieve.
Fetch AllSet to true to retrieve all results.false
ExpandRetrieves related resources.
FilterFilters results (rows).
FormatReturns the results in the specified media format.
Order ByOrders results.
SearchReturns results based on search criteria.
SelectFilters properties (columns).
SkipIndexes into a result set. Also used by some APIs to implement paging and can be used together with $top to manually page results.
Skip TokenRetrieves the next page of results from result sets that span multiple pages.
TopSets the page size of results.
Debug RequestEnabling this flag will log out the current request.false

Raw Request

Send raw HTTP request to Microsoft Excel API.

InputCommentsDefault
Connection
URLInput the path only (/me/drive), The base URL is already included (https://graph.microsoft.com/v1.0). For example, to connect to https://graph.microsoft.com/v1.0/me/drive, only /me/drive is entered in this field.
MethodThe HTTP method to use.
DataThe HTTP body payload to send to the URL.
Form DataThe Form Data to be sent as a multipart form upload.
File DataFile Data to be sent as a multipart form upload.
File Data File NamesFile names to apply to the file data inputs. Keys must match the file data keys above.
Query ParameterA list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.
HeaderA list of headers to send with the request.
Response TypeThe type of data you expect in the response. You can request json, text, or binary data.json
TimeoutThe maximum time that a client will await a response to its request
Debug RequestEnabling this flag will log out the current request.false
Retry Delay (ms)The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.0
Retry On All ErrorsIf true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.false
Max Retry CountThe maximum number of retries to attempt. Specify 0 for no retries.0
Use Exponential BackoffSpecifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.false

Read From Buffer

Parse an xlsx file from a Buffer, outputs an array of worksheets

InputCommentsDefault
FileProvide a Spreadsheet (file/buffer) to be parsed into array values.

Read From URL

Parse an xlsx file from a URL endpoint, outputs an array of worksheets

InputCommentsDefault
File URLThe URL of the file to be parsed

Update Cell Range

Update the properties of range object.

InputCommentsDefault
Connection
Drive or Site IDThe ID of the OneDrive or SharePoint site to list workbooks from.
Workbook IDThe ID of the workbook that contains the worksheet to update cells from.
Worksheet IDThe ID or name of the worksheet to update cells from.
AddressThe address of the range to update.
Column HiddenRepresents if all columns of the current range are hidden.false
Row HiddenRepresents if all rows of the current range are hidden.false
FormulasRepresents the formula in A1-style notation.
Formulas LocalRepresents the formula in A1-style notation, in the user's language and number-formatting locale. For example, the English '=SUM(A1, 1.5)' formula would become '=SUMME(A1; 1,5)' in German.
Formulas R1C1Represents the formula in R1C1-style notation.
Number FormatRepresents Excel's number format code for the given cell.
ValuesRepresents the raw values of the specified range. The data returned could be of type string, number, or a Boolean. Cell that contains an error returns the error string.
Debug RequestEnabling this flag will log out the current request.false

Update Column

Updates a column object from a worksheet table.

InputCommentsDefault
Connection
Drive or Site IDThe ID of the OneDrive or SharePoint site to list workbooks from.
Workbook IDThe ID of the workbook that contains the worksheet to update the column from.
Worksheet IDThe ID or name of the worksheet to update the column from.
Table IDThe ID or name of the table to update the column from.
Column IndexThe id or name of the column to update.
ValuesRepresents the raw values of the specified range.
Debug RequestEnabling this flag will log out the current request.false

Update Table

Updates a table object from a worksheet.

InputCommentsDefault
Connection
Drive or Site IDThe ID of the OneDrive or SharePoint site to list workbooks from.
Workbook IDThe ID of the workbook that contains the worksheet to update the table from.
Worksheet IDThe ID or name of the worksheet to update the table from.
Table IDThe ID or name of the table to update.
NameThe name of the table.
Show HeadersWhether to show the headers of the table.false
Show TotalsWhether to show the totals of the table.false
StyleThe style of the table.
Debug RequestEnabling this flag will log out the current request.false

Update Worksheet

Updates a worksheet object from a workbook.

InputCommentsDefault
Connection
Drive or Site IDThe ID of the OneDrive or SharePoint site to list workbooks from.
Workbook IDThe ID of the workbook that contains the worksheet to update.
Worksheet IDThe ID of the worksheet to update.
Worksheet NameThe new display name of the worksheet.
PositionThe zero-based position of the worksheet within the workbook.
Worksheet VisibilityThe visibility of the worksheet.
Debug RequestEnabling this flag will log out the current request.false