Skip to main content

Microsoft Excel Component

Parse and build .xlsx files (spreadsheets)

Component key: ms-excel

Changelog ↓

Description​

Microsoft Excel is a spreadsheet application developed by Microsoft. It features calculation, graphing tools, pivot tables, and a macro programming language called Visual Basic for Applications. This component allows you to read and build .xlsx files. (spreadsheets)

Connections​

Microsoft Excel OAuth 2.0​

Once you have an instance of Microsoft SharePoint or OneDrive licensed to your account, you will need to create and configure a new "App Registration" within your Azure Active Directory tenant. When creating the application you will be prompted to select the 'Supported account types'. Under this section, be sure to select 'Accounts in any organizational directory (Any Azure AD directory - Multitenant)'.

You will need to go to "Platforms" and add the "Web" platform. In that section you should add the OAuth 2.0 callback URL - https://oauth2.prismatic.io/callback - as a Redirect URI.

Next, go to "Certificates & Secrets" for the app and add a new Client Secret. Note this value as you will need to supply it to the connection.

You will also need the Application (client) ID from the "Overview" page.

The last step of configuring the "App Registration" is assigning "App Permissions". Click "Add Permission", click on the square labeled "Microsoft Graph", and then "Delegated permissions". You should select all permissions that are required for your desired integration.

  • Additionally, ensure the offline_access scope is included in your app registration. It is essential to maintain your OAuth connection and receive refresh tokens. Without it, users will need to re-authenticate every hour.

Now, configure the OAuth 2.0 connection. Add an Microsoft Excel OAuth 2.0 connection config variable:

  • Use the Application (client) ID value for the Client ID field.
  • Use the Client Secret for the same named field.
  • If you didn't select Multitenant when creating the Azure application, you will need to replace the Authorize URL and Token URL with ones specific to your tenant.

Save your integration and you should be able to authenticate a user through Microsoft Excel with OAuth 2.0.

InputNotesExample
Authorize URL

The OAuth 2.0 Authorization URL for Microsoft Excel

https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Client ID

Get this value from your App Registration in the Azure Portal

Client Secret

Get this value from your App Registration in the Azure Portal

Scopes

Microsoft Excel Scopes.

Files.ReadWrite.All Sites.Read.All Sites.ReadWrite.All offline_access
Source

The source from which the workbooks will be listed.

Token URL

The OAuth 2.0 Token URL for Microsoft Excel

https://login.microsoftonline.com/common/oauth2/v2.0/token

Data Sources​

Select Column​

Select a column from the list of columns. | key: selectColumn | type: picklist

InputNotesExample
Connection
Drive or Site ID

The ID of the OneDrive or SharePoint site to list workbooks from.

b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Table ID

The ID or name of the table to list columns from.

{12B25C6E-59A4-4316-BE2E-325B2C8EDD50}
Workbook ID

The ID of the workbook that contains the worksheet to list columns from.

02J363WTJPABCDEFGTIRHYMKT7BX7JJZXQ
Worksheet ID

The ID or name of the worksheet to list columns from.

{00000000-0001-0000-0000-000000000000}

Select Drive or Site​

Select a drive or site from the list of drives and sites. | key: selectDriveOrSite | type: picklist

InputNotesExample
Connection

Select Table​

Select a table from the list of tables. | key: selectTable | type: picklist

InputNotesExample
Connection
Drive or Site ID

The ID of the OneDrive or SharePoint site to list workbooks from.

b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Workbook ID

The ID of the workbook that contains the worksheet to list tables from.

02J363WTJPABCDEFGTIRHYMKT7BX7JJZXQ
Worksheet ID

The ID or name of the worksheet to list tables from.

{00000000-0001-0000-0000-000000000000}

Select Workbook​

Select a workbook from the list of workbooks. | key: selectWorkbook | type: picklist

InputNotesExample
Connection
Drive or Site ID

The ID of the OneDrive or SharePoint site to list workbooks from. Use this or Path.

b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
List or Item ID

The ID of the list or item to retrieve.

01J363WTN6Y2GOVW7725BZO354PWSELRRZ
Path

The path to the file or folder. Use this or Drive Or Site Id.

/drive/root:/folder/file.xlsx

Select Worksheet​

Select a worksheet from the list of worksheets. | key: selectWorksheet | type: picklist

InputNotesExample
Connection
Drive or Site ID

The ID of the OneDrive or SharePoint site to list workbooks from.

b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Workbook ID

The ID of the workbook to retrieve.

02J363WTJPABCDEFGTIRHYMKT7BX7JJZXQ

Actions​

Build Spreadsheet​

Creates a buffer containing a spreadsheet made from a 2D JavaScript array, | key: build

InputNotesExample
Create Options

Here 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

File Name

Provide a string value for the name of the file.

mySheet
Spreadsheet Data

For each item, provide a list of items representing the items to be inserted.

{
  "data": {}
}

Build Spreadsheet with Multiple Sheets​

Creates a buffer containing multiple spreadsheets made from a 3D JavaScript array. | key: buildMultiple

InputNotesExample
Structured Sheet Names

Use 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 Options

Here 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

Spreadsheet Data

For each item, provide a list with a list items representing the cells to be inserted.

Sheet Names

Provide a string value for the name of the file.

mySheet

{
  "data": {}
}

Clear Cell Range​

Clear range values such as format, fill, and border. | key: clearCellRange

InputNotesExample
Address

The address of the range to update.

A1:B2
Apply To

Determines the type of clear action.

Connection
Drive or Site ID

The ID of the OneDrive or SharePoint site to list workbooks from.

b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Workbook ID

The ID of the workbook that contains the worksheet to clear cells from.

02J363WTJPABCDEFGTIRHYMKT7BX7JJZXQ
Worksheet ID

The ID or name of the worksheet to clear cells from.

{00000000-0001-0000-0000-000000000000}

{
  "data": "CLEARED SUCCESSFULLY"
}

Create Column​

Creates a Column object inside a worksheet table. | key: createColumn

InputNotesExample
Column Id

Specifies 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.

1
Connection
Drive or Site ID

The ID of the OneDrive or SharePoint site to list workbooks from.

b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Table ID

The ID or name of the table to create the column in.

{12B25C6E-59A4-4316-BE2E-325B2C8EDD50}
Values

A two-dimensional array of unformatted values of the table column.

Workbook ID

The ID of the workbook that contains the worksheet to create the column in.

02J363WTJPABCDEFGTIRHYMKT7BX7JJZXQ
Worksheet ID

The ID or name of the worksheet to create the column in.

{00000000-0001-0000-0000-000000000000}

{
  "data": {
    "values": [
      [
        "Column1"
      ],
      [
        "Test"
      ]
    ],
    "id": "1",
    "index": 0,
    "name": "Column1"
  }
}

Create Multiple Rows​

Adds rows to the end of a table. | key: createMultipleRows

InputNotesExample
Connection
Drive or Site ID

The ID of the OneDrive or SharePoint site to list workbooks from.

b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Row Index

Specifies 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.

99
Table ID

The ID or name of the table to create the row in.

{12B25C6E-59A4-4316-BE2E-325B2C8EDD50}
Values

The values to update in the row.

Workbook ID

The ID of the workbook that contains the worksheet to create the row in.

02J363WTJPABCDEFGTIRHYMKT7BX7JJZXQ
Worksheet ID

The ID or name of the worksheet to create the row in.

{00000000-0001-0000-0000-000000000000}

{
  "data": {
    "index": 99,
    "values": "values-value"
  }
}

Create Row​

Creates a row object inside a worksheet table. | key: createRow

InputNotesExample
Connection
Drive or Site ID

The ID of the OneDrive or SharePoint site to list workbooks from.

b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Row Index

Specifies 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.

99
Table ID

The ID or name of the table to create the row in.

{12B25C6E-59A4-4316-BE2E-325B2C8EDD50}
Values

The values to update in the row.

Workbook ID

The ID of the workbook that contains the worksheet to create the row in.

02J363WTJPABCDEFGTIRHYMKT7BX7JJZXQ
Worksheet ID

The ID or name of the worksheet to create the row in.

{00000000-0001-0000-0000-000000000000}

{
  "data": {
    "index": 99,
    "values": "values-value"
  }
}

Create Table​

Creates a table object inside a worksheet. | key: createTable

InputNotesExample
Address

Address 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.

A1
Connection
Drive or Site ID

The ID of the OneDrive or SharePoint site to list workbooks from.

b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Has Headers

Boolean 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
Workbook ID

The ID of the workbook that contains the worksheet to create the table in.

02J363WTJPABCDEFGTIRHYMKT7BX7JJZXQ
Worksheet ID

The ID of the worksheet to create the table in.

{00000000-0001-0000-0000-000000000000}

{
  "data": {
    "id": "99",
    "name": "name-value",
    "showHeaders": true,
    "showTotals": true,
    "style": "style-value"
  }
}

Create Worksheet​

Creates a worksheet object inside a workbook. | key: createWorksheet

InputNotesExample
Connection
Drive or Site ID

The ID of the OneDrive or SharePoint site to list workbooks from.

b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Worksheet Name

The display name of the worksheet.

Sheet1
Workbook ID

The ID of the workbook that contains the worksheet to update.

02J363WTJPABCDEFGTIRHYMKT7BX7JJZXQ

{
  "data": {
    "id": "id-value",
    "position": 99,
    "name": "name-value",
    "visibility": "visibility-value"
  }
}

Delete Cell Range​

Deletes the cells associated with the range. | key: deleteCellRange

InputNotesExample
Address

The address of the range to update.

A1:B2
Connection
Drive or Site ID

The ID of the OneDrive or SharePoint site to list workbooks from.

b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Shift

Specifies which way to shift the cells.

Workbook ID

The ID of the workbook that contains the worksheet to delete cells from.

02J363WTJPABCDEFGTIRHYMKT7BX7JJZXQ
Worksheet ID

The ID or name of the worksheet to delete cells from.

{00000000-0001-0000-0000-000000000000}

{
  "data": "DELETED SUCCESSFULLY"
}

Delete Column​

Deletes a column object from a worksheet table. | key: deleteColumn

InputNotesExample
Column Id

The id or name of the column to delete.

1
Connection
Drive or Site ID

The ID of the OneDrive or SharePoint site to list workbooks from.

b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Table ID

The ID or name of the table to delete the column from.

{12B25C6E-59A4-4316-BE2E-325B2C8EDD50}
Workbook ID

The ID of the workbook that contains the worksheet to delete the column from.

02J363WTJPABCDEFGTIRHYMKT7BX7JJZXQ
Worksheet ID

The ID or name of the worksheet to delete the column from.

{00000000-0001-0000-0000-000000000000}

{
  "data": "DELETED SUCCESSFULLY"
}

Delete Table​

Deletes a table object from a worksheet. | key: deleteTable

InputNotesExample
Connection
Drive or Site ID

The ID of the OneDrive or SharePoint site to list workbooks from.

b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Table ID

The ID or name of the table to delete.

{12B25C6E-59A4-4316-BE2E-325B2C8EDD50}
Workbook ID

The ID of the workbook that contains the worksheet to delete the table from.

02J363WTJPABCDEFGTIRHYMKT7BX7JJZXQ
Worksheet ID

The ID or name of the worksheet to delete the table from.

{00000000-0001-0000-0000-000000000000}

{
  "data": "DELETED SUCCESSFULLY"
}

Delete Worksheet​

Deletes a worksheet from a workbook. | key: deleteWorksheet

InputNotesExample
Connection
Drive or Site ID

The ID of the OneDrive or SharePoint site to list workbooks from.

b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Workbook ID

The ID of the workbook that contains the worksheet to delete.

02J363WTJPABCDEFGTIRHYMKT7BX7JJZXQ
Worksheet ID

The ID of the worksheet to delete.

{00000000-0001-0000-0000-000000000000}

{
  "data": "DELETED SUCCESSFULLY"
}

Get Cell​

Retrieves a cell from a worksheet. | key: getCell

InputNotesExample
Column Index

The number of the column to retrieve.

99
Connection
Drive or Site ID

The ID of the OneDrive or SharePoint site to list workbooks from.

b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Row Index

The number of the row to retrieve.

99
Workbook ID

The ID of the workbook that contains the worksheet to list cells from.

02J363WTJPABCDEFGTIRHYMKT7BX7JJZXQ
Worksheet ID

The ID or name of the worksheet to list cells from.

{00000000-0001-0000-0000-000000000000}

{
  "data": {
    "address": "address-value",
    "addressLocal": "addressLocal-value",
    "cellCount": 99,
    "columnCount": 99,
    "columnIndex": 99,
    "valueTypes": "valueTypes-value"
  }
}

Get Cell Range​

Retrieve the properties and relationships of range object. | key: getCellRange

InputNotesExample
Connection
Drive or Site ID

The ID of the OneDrive or SharePoint site to list workbooks from.

b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Workbook ID

The ID of the workbook that contains the worksheet to list cells from.

02J363WTJPABCDEFGTIRHYMKT7BX7JJZXQ
Worksheet ID

The ID or name of the worksheet to list cells from.

{00000000-0001-0000-0000-000000000000}

{
  "data": {
    "address": "address-value",
    "addressLocal": "addressLocal-value",
    "cellCount": 99,
    "columnCount": 99,
    "columnIndex": 99,
    "valueTypes": "valueTypes-value"
  }
}

Get Column​

Retrieves a column object from a worksheet table. | key: getColumn

InputNotesExample
Column Id

The id or name of the column to retrieve.

1
Connection
Drive or Site ID

The ID of the OneDrive or SharePoint site to list workbooks from.

b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Table ID

The ID or name of the table to list column from.

{12B25C6E-59A4-4316-BE2E-325B2C8EDD50}
Workbook ID

The ID of the workbook that contains the worksheet to list column from.

02J363WTJPABCDEFGTIRHYMKT7BX7JJZXQ
Worksheet ID

The ID or name of the worksheet to list column from.

{00000000-0001-0000-0000-000000000000}

{
  "data": {
    "values": [
      [
        "Column1"
      ],
      [
        "Test"
      ]
    ],
    "id": "1",
    "index": 0,
    "name": "Column1"
  }
}

Get Table​

Retrieves a table object from a worksheet. | key: getTable

InputNotesExample
Connection
Drive or Site ID

The ID of the OneDrive or SharePoint site to list workbooks from.

b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Table ID

The ID or name of the table to retrieve

{12B25C6E-59A4-4316-BE2E-325B2C8EDD50}
Workbook ID

The ID of the workbook that contains the worksheet to get the table from.

02J363WTJPABCDEFGTIRHYMKT7BX7JJZXQ
Worksheet ID

The ID or name of the worksheet to get the table from.

{00000000-0001-0000-0000-000000000000}

{
  "data": {
    "id": "99",
    "name": "name-value",
    "showHeaders": true,
    "showTotals": true,
    "style": "style-value"
  }
}

Get Worksheet​

Retrieves a worksheet object from a workbook. | key: getWorksheet

InputNotesExample
Connection
Drive or Site ID

The ID of the OneDrive or SharePoint site to list workbooks from.

b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Workbook ID

The ID of the workbook to retrieve.

02J363WTJPABCDEFGTIRHYMKT7BX7JJZXQ
Worksheet ID

The ID or name of the worksheet to retrieve.

{00000000-0001-0000-0000-000000000000}

{
  "data": {
    "id": "id-value",
    "position": 99,
    "name": "name-value",
    "visibility": "visibility-value"
  }
}

List Columns​

Retrieve a list of columns from a worksheet table. | key: listColumns

InputNotesExample
Expand

Retrieves related resources.

members
Filter

Filters results (rows).

startswith(givenName,'J')
Format

Returns the results in the specified media format.

json
Order By

Orders results.

displayName desc
Search

Returns results based on search criteria.

pizza
Select

Filters properties (columns).

givenName,surname
Skip

Indexes into a result set. Also used by some APIs to implement paging and can be used together with $top to manually page results.

10
Skip Token

Retrieves the next page of results from result sets that span multiple pages.

X%274453707402000100000017...
Top

Sets the page size of results.

10
Connection
Drive or Site ID

The ID of the OneDrive or SharePoint site to list workbooks from.

b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Fetch All

Set to true to retrieve all results.

false
Table ID

The ID or name of the table to list columns from.

{12B25C6E-59A4-4316-BE2E-325B2C8EDD50}
Workbook ID

The ID of the workbook that contains the worksheet to list columns from.

02J363WTJPABCDEFGTIRHYMKT7BX7JJZXQ
Worksheet ID

The ID or name of the worksheet to list columns from.

{00000000-0001-0000-0000-000000000000}

{
  "data": {
    "value": [
      {
        "values": [
          [
            "Column1"
          ],
          [
            "Test"
          ]
        ],
        "id": "1",
        "index": 0,
        "name": "Column1"
      }
    ]
  }
}

List Rows​

Retrieve a list of rows from a worksheet table. | key: listRows

InputNotesExample
Expand

Retrieves related resources.

members
Filter

Filters results (rows).

startswith(givenName,'J')
Format

Returns the results in the specified media format.

json
Order By

Orders results.

displayName desc
Search

Returns results based on search criteria.

pizza
Select

Filters properties (columns).

givenName,surname
Skip

Indexes into a result set. Also used by some APIs to implement paging and can be used together with $top to manually page results.

10
Skip Token

Retrieves the next page of results from result sets that span multiple pages.

X%274453707402000100000017...
Top

Sets the page size of results.

10
Connection
Drive or Site ID

The ID of the OneDrive or SharePoint site to list workbooks from.

b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Fetch All

Set to true to retrieve all results.

false
Table ID

The ID or name of the table to list rows from.

{12B25C6E-59A4-4316-BE2E-325B2C8EDD50}
Workbook ID

The ID of the workbook that contains the worksheet to list rows from.

02J363WTJPABCDEFGTIRHYMKT7BX7JJZXQ
Worksheet ID

The ID or name of the worksheet to list rows from.

{00000000-0001-0000-0000-000000000000}

{
  "data": {
    "value": [
      {
        "index": 99,
        "values": "values-value"
      }
    ]
  }
}

List Tables​

Retrieve a list of tables from a worksheet. | key: listTables

InputNotesExample
Expand

Retrieves related resources.

members
Filter

Filters results (rows).

startswith(givenName,'J')
Format

Returns the results in the specified media format.

json
Order By

Orders results.

displayName desc
Search

Returns results based on search criteria.

pizza
Select

Filters properties (columns).

givenName,surname
Skip

Indexes into a result set. Also used by some APIs to implement paging and can be used together with $top to manually page results.

10
Skip Token

Retrieves the next page of results from result sets that span multiple pages.

X%274453707402000100000017...
Top

Sets the page size of results.

10
Connection
Drive or Site ID

The ID of the OneDrive or SharePoint site to list workbooks from.

b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Fetch All

Set to true to retrieve all results.

false
Workbook ID

The ID of the workbook that contains the worksheet to list tables from.

02J363WTJPABCDEFGTIRHYMKT7BX7JJZXQ
Worksheet ID

The ID or name of the worksheet to list tables from.

{00000000-0001-0000-0000-000000000000}

{
  "data": {
    "value": [
      {
        "id": "99",
        "name": "name-value",
        "showHeaders": true,
        "showTotals": true,
        "style": "style-value"
      }
    ]
  }
}

List Workbooks​

Return a collection of Workbooks from either a OneDrive or SharePoint site. | key: listWorkbooks

InputNotesExample
Expand

Retrieves related resources.

members
Order By

Orders results.

displayName desc
Select

Filters properties (columns).

givenName,surname
Skip Token

Retrieves the next page of results from result sets that span multiple pages.

X%274453707402000100000017...
Top

Sets the page size of results.

10
Connection
Drive or Site ID

The ID of the OneDrive or SharePoint site to list workbooks from. Use this or Path.

b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Fetch All

Set to true to retrieve all results.

false
List or Item ID

The ID of the list or item to retrieve.

01J363WTN6Y2GOVW7725BZO354PWSELRRZ
Path

The path to the file or folder. Use this or Drive Or Site Id.

/drive/root:/folder/file.xlsx

{
  "data": {
    "value": [
      {
        "@microsoft.graph.downloadUrl": "https://example.sharepoint.com/personal/user_example_onmicrosoft_com/_layouts/15/download.aspx?UniqueId=11111111-1111-1111-1111-111111111111&Translate=false&tempauth=EXAMPLETOKEN&ApiVersion=2.0",
        "createdBy": {
          "user": {
            "email": "user@example.onmicrosoft.com",
            "id": "00000000-0000-0000-0000-000000000000",
            "displayName": "Example User"
          }
        },
        "createdDateTime": "2025-07-03T19:12:11Z",
        "eTag": "\"{11111111-1111-1111-1111-111111111111},1\"",
        "id": "01ABCDEF123456XYZ",
        "lastModifiedBy": {
          "user": {
            "email": "user@example.onmicrosoft.com",
            "id": "00000000-0000-0000-0000-000000000000",
            "displayName": "Example User"
          }
        },
        "lastModifiedDateTime": "2025-07-03T19:24:55Z",
        "name": "Workbook.xlsx",
        "parentReference": {
          "driveType": "business",
          "driveId": "b!exampleDriveId123456789",
          "id": "01PARENTITEM123456XYZ",
          "name": "ExampleFolder",
          "path": "/drives/b!exampleDriveId123456789/root:/ExampleFolder",
          "siteId": "00000000-0000-0000-0000-000000000000"
        },
        "webUrl": "https://example.sharepoint.com/personal/user_example_onmicrosoft_com/_layouts/15/Doc.aspx?sourcedoc=%7B11111111-1111-1111-1111-111111111111%7D&file=Workbook.xlsx&action=default&mobileredirect=true",
        "cTag": "\"c:{11111111-1111-1111-1111-111111111111},1\"",
        "file": {
          "hashes": {
            "quickXorHash": "EXAMPLEHASH1234567890=="
          },
          "mimeType": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"
        },
        "fileSystemInfo": {
          "createdDateTime": "2025-07-03T19:12:11Z",
          "lastModifiedDateTime": "2025-07-03T19:24:55Z"
        },
        "shared": {
          "scope": "users"
        },
        "size": 6727
      }
    ]
  }
}

List Worksheets​

Retrieve a list of worksheet objects. | key: listWorksheets

InputNotesExample
Expand

Retrieves related resources.

members
Filter

Filters results (rows).

startswith(givenName,'J')
Format

Returns the results in the specified media format.

json
Order By

Orders results.

displayName desc
Search

Returns results based on search criteria.

pizza
Select

Filters properties (columns).

givenName,surname
Skip

Indexes into a result set. Also used by some APIs to implement paging and can be used together with $top to manually page results.

10
Skip Token

Retrieves the next page of results from result sets that span multiple pages.

X%274453707402000100000017...
Top

Sets the page size of results.

10
Connection
Drive or Site ID

The ID of the OneDrive or SharePoint site to list workbooks from.

b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Fetch All

Set to true to retrieve all results.

false
Workbook ID

The ID of the workbook to retrieve.

02J363WTJPABCDEFGTIRHYMKT7BX7JJZXQ

{
  "data": {
    "value": [
      {
        "id": "id-value",
        "position": 99,
        "name": "name-value",
        "visibility": "visibility-value"
      }
    ]
  }
}

Raw Request​

Send raw HTTP request to Microsoft Excel API. | key: rawRequest

InputNotesExample
Connection
Data

The HTTP body payload to send to the URL.

{"exampleKey": "Example Data"}
File Data

File Data to be sent as a multipart form upload.

[{key: "example.txt", value: "My File Contents"}]
File Data File Names

File names to apply to the file data inputs. Keys must match the file data keys above.

Form Data

The Form Data to be sent as a multipart form upload.

[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header

A list of headers to send with the request.

User-Agent: curl/7.64.1
Max Retry Count

The maximum number of retries to attempt. Specify 0 for no retries.

0
Method

The HTTP method to use.

Query Parameter

A 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.

Response Type

The type of data you expect in the response. You can request json, text, or binary data.

json
Retry On All Errors

If 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
Retry Delay (ms)

The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.

0
Timeout

The maximum time that a client will await a response to its request

2000
URL

Input 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.

/me/drive
Use Exponential Backoff

Specifies 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 | key: parseBuffer

InputNotesExample
File

Provide 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 | key: parse

InputNotesExample
File URL

The URL of the file to be parsed

https://example.com/file.xlsx

Update Cell Range​

Update the properties of range object. | key: updateCellRange

InputNotesExample
Address

The address of the range to update.

A1:B2
Column Hidden

Represents if all columns of the current range are hidden.

false
Connection
Drive or Site ID

The ID of the OneDrive or SharePoint site to list workbooks from.

b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Formulas

Represents the formula in A1-style notation.

Formulas Local

Represents 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 R1C1

Represents the formula in R1C1-style notation.

Number Format

Represents Excel's number format code for the given cell.

Row Hidden

Represents if all rows of the current range are hidden.

false
Values

Represents 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.

Workbook ID

The ID of the workbook that contains the worksheet to update cells from.

02J363WTJPABCDEFGTIRHYMKT7BX7JJZXQ
Worksheet ID

The ID or name of the worksheet to update cells from.

{00000000-0001-0000-0000-000000000000}

{
  "data": {
    "address": "address-value",
    "addressLocal": "addressLocal-value",
    "cellCount": 99,
    "columnCount": 99,
    "columnIndex": 99,
    "valueTypes": "valueTypes-value"
  }
}

Update Column​

Updates a column object from a worksheet table. | key: updateColumn

InputNotesExample
Column Id

The id or name of the column to update.

1
Connection
Drive or Site ID

The ID of the OneDrive or SharePoint site to list workbooks from.

b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Table ID

The ID or name of the table to update the column from.

{12B25C6E-59A4-4316-BE2E-325B2C8EDD50}
Values

Represents the raw values of the specified range.

Workbook ID

The ID of the workbook that contains the worksheet to update the column from.

02J363WTJPABCDEFGTIRHYMKT7BX7JJZXQ
Worksheet ID

The ID or name of the worksheet to update the column from.

{00000000-0001-0000-0000-000000000000}

{
  "data": {
    "values": [
      [
        "Column1"
      ],
      [
        "Test"
      ]
    ],
    "id": "1",
    "index": 0,
    "name": "Column1"
  }
}

Update Table​

Updates a table object from a worksheet. | key: updateTable

InputNotesExample
Connection
Drive or Site ID

The ID of the OneDrive or SharePoint site to list workbooks from.

b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Name

The name of the table.

Table1
Show Headers

Whether to show the headers of the table.

false
Show Totals

Whether to show the totals of the table.

false
Style

The style of the table.

Table ID

The ID or name of the table to update.

{12B25C6E-59A4-4316-BE2E-325B2C8EDD50}
Workbook ID

The ID of the workbook that contains the worksheet to update the table from.

02J363WTJPABCDEFGTIRHYMKT7BX7JJZXQ
Worksheet ID

The ID or name of the worksheet to update the table from.

{00000000-0001-0000-0000-000000000000}

{
  "data": {
    "id": "99",
    "name": "name-value",
    "showHeaders": true,
    "showTotals": true,
    "style": "style-value"
  }
}

Update Worksheet​

Updates a worksheet object from a workbook. | key: updateWorksheet

InputNotesExample
Connection
Drive or Site ID

The ID of the OneDrive or SharePoint site to list workbooks from.

b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Worksheet Name

The new display name of the worksheet.

Sheet1
Position

The zero-based position of the worksheet within the workbook.

0
Worksheet Visibility

The visibility of the worksheet.

Workbook ID

The ID of the workbook that contains the worksheet to update.

02J363WTJPABCDEFGTIRHYMKT7BX7JJZXQ
Worksheet ID

The ID of the worksheet to update.

{00000000-0001-0000-0000-000000000000}

{
  "data": {
    "id": "id-value",
    "position": 99,
    "name": "name-value",
    "visibility": "visibility-value"
  }
}

Changelog​

2025-07-10​

Added inline data sources for selecting columns, tables, workbooks, worksheets, and drives or sites to enhance data selection capabilities.

2025-07-04​

Added drive name labels for better readability in the user interface.