Microsoft Excel Component

Parse and build .xlsx files (spreadsheets)

Component key: ms-excel

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

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 Prismatic's OAuth 2.0 callback URL - https://oauth2.prismatic.io/callback - as a Redirect URI for US based integrations.

For integrations outside the US refer to this guide to find your region's Callback URL.

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 within Prismatic.

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 ", and then "Delegated permissions". You should select all permissions that are required for your desired integration.

Now, configure the OAuth 2.0 connection in Prismatic. 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.

Input	Default	Notes
Authorize URL string / Required Hidden Field authorizeUrl	https://login.microsoftonline.com/common/oauth2/v2.0/authorize	The OAuth 2.0 Authorization URL for Microsoft Excel
Client ID string / Required clientId		Get this value from your App Registration in the Azure Portal
Client Secret password / Required clientSecret		Get this value from your App Registration in the Azure Portal
Scopes string / Required scopes	Files.ReadWrite.All Sites.Read.All Sites.ReadWrite.All offline_access	Microsoft Excel Scopes.
Source string / Required source		The source from which the workbooks will be listed.
Token URL string / Required Hidden Field tokenUrl	https://login.microsoftonline.com/common/oauth2/v2.0/token	The OAuth 2.0 Token URL for Microsoft Excel

Actions

Build Spreadsheet

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

Input	Notes	Example
Create Options code createOptions	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 string / Required fileName	Provide a string value for the name of the file.	mySheet
Spreadsheet Data code / Required sheetData	For each item, provide a list of items representing the items to be inserted.

Example Payload for Build Spreadsheet

{
  "data": {
    "type": "Buffer",
    "data": [
      115,
      97,
      109,
      112,
      108,
      101,
      66,
      117,
      102,
      102,
      101,
      114
    ]
  }
}

Build Spreadsheet with Multiple Sheets

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

Input	Notes	Example
Structured Sheet Names code alternativeSheetNames	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 code createOptions	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 code / Required multiSheetData	For each item, provide a list with a list items representing the cells to be inserted.
Sheet Names string Value List sheetNames	Provide a string value for the name of the file.	mySheet

Example Payload for Build Spreadsheet with Multiple Sheets

{
  "data": {
    "type": "Buffer",
    "data": [
      115,
      97,
      109,
      112,
      108,
      101,
      66,
      117,
      102,
      102,
      101,
      114
    ]
  }
}

Clear Cell Range

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

Input	Default	Notes	Example
Address string / Required address		The address of the range to update.	A1:B2
Apply To string applyTo		Determines the type of clear action.
Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Drive or Site ID string / Required driveOrSiteId		The ID of the OneDrive or SharePoint site to list workbooks from.	b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Workbook ID string / Required workbookId		The ID of the workbook that contains the worksheet to clear cells from.	123456
Worksheet ID string / Required worksheetId		The ID or name of the worksheet to clear cells from.	123456

Example Payload for Clear Cell Range

{
  "data": "CLEARED SUCCESSFULLY"
}

Create Column

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

Input	Default	Notes	Example
Column Index string columnId		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.	99
Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Drive or Site ID string / Required driveOrSiteId		The ID of the OneDrive or SharePoint site to list workbooks from.	b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Table ID string / Required tableId		The ID or name of the table to create the column in.	66
Values code values		A two-dimensional array of unformatted values of the table column.
Workbook ID string / Required workbookId		The ID of the workbook that contains the worksheet to create the column in.	123456
Worksheet ID string / Required worksheetId		The ID or name of the worksheet to create the column in.	123456

Example Payload for Create Column

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

Create Multiple Rows

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

Input	Default	Notes	Example
Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Drive or Site ID string / Required driveOrSiteId		The ID of the OneDrive or SharePoint site to list workbooks from.	b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Row Index string rowId		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 string / Required tableId		The ID or name of the table to create the row in.	66
Values code values		The values to update in the row.
Workbook ID string / Required workbookId		The ID of the workbook that contains the worksheet to create the row in.	123456
Worksheet ID string / Required worksheetId		The ID or name of the worksheet to create the row in.	123456

Example Payload for Create Multiple Rows

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

Create Row

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

Input	Default	Notes	Example
Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Drive or Site ID string / Required driveOrSiteId		The ID of the OneDrive or SharePoint site to list workbooks from.	b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Row Index string rowId		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 string / Required tableId		The ID or name of the table to create the row in.	66
Values code / Required values		The values to update in the row.
Workbook ID string / Required workbookId		The ID of the workbook that contains the worksheet to create the row in.	123456
Worksheet ID string / Required worksheetId		The ID or name of the worksheet to create the row in.	123456

Example Payload for Create Row

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

Create Table

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

Input	Default	Notes	Example
Address string / Required 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 connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Drive or Site ID string / Required driveOrSiteId		The ID of the OneDrive or SharePoint site to list workbooks from.	b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Has Headers boolean / Required hasHeaders	false	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.
Workbook ID string / Required workbookId		The ID of the workbook that contains the worksheet to create the table in.	123456
Worksheet ID string / Required worksheetId		The ID of the worksheet to create the table in.	123456

Example Payload for Create Table

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

Create Worksheet

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

Input	Default	Notes	Example
Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Drive or Site ID string / Required driveOrSiteId		The ID of the OneDrive or SharePoint site to list workbooks from.	b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Worksheet Name string / Required name		The display name of the worksheet.	Sheet1
Workbook ID string / Required workbookId		The ID of the workbook that contains the worksheet to update.	123456

Example Payload for Create Worksheet

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

Delete Cell Range

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

Input	Default	Notes	Example
Address string / Required address		The address of the range to update.	A1:B2
Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Drive or Site ID string / Required driveOrSiteId		The ID of the OneDrive or SharePoint site to list workbooks from.	b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Shift string / Required shift		Specifies which way to shift the cells.
Workbook ID string / Required workbookId		The ID of the workbook that contains the worksheet to delete cells from.	123456
Worksheet ID string / Required worksheetId		The ID or name of the worksheet to delete cells from.	123456

Example Payload for Delete Cell Range

{
  "data": "DELETED SUCCESSFULLY"
}

Delete Column

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

Input	Default	Notes	Example
Column Index string / Required columnId		The id or name of the column to delete.	99
Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Drive or Site ID string / Required driveOrSiteId		The ID of the OneDrive or SharePoint site to list workbooks from.	b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Table ID string / Required tableId		The ID or name of the table to delete the column from.	66
Workbook ID string / Required workbookId		The ID of the workbook that contains the worksheet to delete the column from.	123456
Worksheet ID string / Required worksheetId		The ID or name of the worksheet to delete the column from.	123456

Example Payload for Delete Column

{
  "data": "DELETED SUCCESSFULLY"
}

Delete Table

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

Input	Default	Notes	Example
Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Drive or Site ID string / Required driveOrSiteId		The ID of the OneDrive or SharePoint site to list workbooks from.	b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Table ID string / Required tableId		The ID or name of the table to delete.	66
Workbook ID string / Required workbookId		The ID of the workbook that contains the worksheet to delete the table from.	123456
Worksheet ID string / Required worksheetId		The ID or name of the worksheet to delete the table from.	123456

Example Payload for Delete Table

{
  "data": "DELETED SUCCESSFULLY"
}

Delete Worksheet

Deletes a worksheet from a workbook. | key: deleteWorksheet

Input	Default	Notes	Example
Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Drive or Site ID string / Required driveOrSiteId		The ID of the OneDrive or SharePoint site to list workbooks from.	b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Workbook ID string / Required workbookId		The ID of the workbook that contains the worksheet to delete.	123456
Worksheet ID string / Required worksheetId		The ID of the worksheet to delete.	123456

Example Payload for Delete Worksheet

{
  "data": "DELETED SUCCESSFULLY"
}

Get Cell

Retrieves a cell from a worksheet. | key: getCell

Input	Default	Notes	Example
Column Index string / Required column		The number of the column to retrieve.	99
Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Drive or Site ID string / Required driveOrSiteId		The ID of the OneDrive or SharePoint site to list workbooks from.	b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Row Index string / Required row		The number of the row to retrieve.	99
Workbook ID string / Required workbookId		The ID of the workbook that contains the worksheet to list cells from.	123456
Worksheet ID string / Required worksheetId		The ID or name of the worksheet to list cells from.	123456

Example Payload for Get Cell

{
  "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

Input	Default	Notes	Example
Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Drive or Site ID string / Required driveOrSiteId		The ID of the OneDrive or SharePoint site to list workbooks from.	b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Workbook ID string / Required workbookId		The ID of the workbook that contains the worksheet to list cells from.	123456
Worksheet ID string / Required worksheetId		The ID or name of the worksheet to list cells from.	123456

Example Payload for Get Cell Range

{
  "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

Input	Default	Notes	Example
Column Index string / Required columnId		The id or name of the column to retrieve.	99
Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Drive or Site ID string / Required driveOrSiteId		The ID of the OneDrive or SharePoint site to list workbooks from.	b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Table ID string / Required tableId		The ID or name of the table to list column from.	66
Workbook ID string / Required workbookId		The ID of the workbook that contains the worksheet to list column from.	123456
Worksheet ID string / Required worksheetId		The ID or name of the worksheet to list column from.	123456

Example Payload for Get Column

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

Get Table

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

Input	Default	Notes	Example
Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Drive or Site ID string / Required driveOrSiteId		The ID of the OneDrive or SharePoint site to list workbooks from.	b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Table ID string / Required tableId		The ID or name of the table to retrieve	66
Workbook ID string / Required workbookId		The ID of the workbook that contains the worksheet to get the table from.	123456
Worksheet ID string / Required worksheetId		The ID or name of the worksheet to get the table from.	123456

Example Payload for Get Table

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

Get Worksheet

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

Input	Default	Notes	Example
Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Drive or Site ID string / Required driveOrSiteId		The ID of the OneDrive or SharePoint site to list workbooks from.	b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Workbook ID string / Required workbookId		The ID of the workbook to retrieve.	123456
Worksheet ID string / Required worksheetId		The ID or name of the worksheet to retrieve.	123456

Example Payload for Get Worksheet

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

List Columns

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

Input	Default	Notes	Example
Expand string $expand		Retrieves related resources.	members
Filter string $filter		Filters results (rows).	startswith(givenName,'J')
Format string $format		Returns the results in the specified media format.	json
Order By string $orderBy		Orders results.	displayName desc
Search string $search		Returns results based on search criteria.	pizza
Select string $select		Filters properties (columns).	givenName,surname
Skip string $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 string $skipToken		Retrieves the next page of results from result sets that span multiple pages.	X%274453707402000100000017...
Top string $top		Sets the page size of results.	10
Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Drive or Site ID string / Required driveOrSiteId		The ID of the OneDrive or SharePoint site to list workbooks from.	b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Fetch All boolean fetchAll	false	Set to true to retrieve all results.
Table ID string / Required tableId		The ID or name of the table to list columns from.	66
Workbook ID string / Required workbookId		The ID of the workbook that contains the worksheet to list columns from.	123456
Worksheet ID string / Required worksheetId		The ID or name of the worksheet to list columns from.	123456

Example Payload for List Columns

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

List Rows

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

Input	Default	Notes	Example
Expand string $expand		Retrieves related resources.	members
Filter string $filter		Filters results (rows).	startswith(givenName,'J')
Format string $format		Returns the results in the specified media format.	json
Order By string $orderBy		Orders results.	displayName desc
Search string $search		Returns results based on search criteria.	pizza
Select string $select		Filters properties (columns).	givenName,surname
Skip string $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 string $skipToken		Retrieves the next page of results from result sets that span multiple pages.	X%274453707402000100000017...
Top string $top		Sets the page size of results.	10
Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Drive or Site ID string / Required driveOrSiteId		The ID of the OneDrive or SharePoint site to list workbooks from.	b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Fetch All boolean fetchAll	false	Set to true to retrieve all results.
Table ID string / Required tableId		The ID or name of the table to list rows from.	66
Workbook ID string / Required workbookId		The ID of the workbook that contains the worksheet to list rows from.	123456
Worksheet ID string / Required worksheetId		The ID or name of the worksheet to list rows from.	123456

Example Payload for List Rows

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

List Tables

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

Input	Default	Notes	Example
Expand string $expand		Retrieves related resources.	members
Filter string $filter		Filters results (rows).	startswith(givenName,'J')
Format string $format		Returns the results in the specified media format.	json
Order By string $orderBy		Orders results.	displayName desc
Search string $search		Returns results based on search criteria.	pizza
Select string $select		Filters properties (columns).	givenName,surname
Skip string $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 string $skipToken		Retrieves the next page of results from result sets that span multiple pages.	X%274453707402000100000017...
Top string $top		Sets the page size of results.	10
Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Drive or Site ID string / Required driveOrSiteId		The ID of the OneDrive or SharePoint site to list workbooks from.	b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Fetch All boolean fetchAll	false	Set to true to retrieve all results.
Workbook ID string / Required workbookId		The ID of the workbook that contains the worksheet to list tables from.	123456
Worksheet ID string / Required worksheetId		The ID or name of the worksheet to list tables from.	123456

Example Payload for List Tables

{
  "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

Input	Default	Notes	Example
Expand string $expand		Retrieves related resources.	members
Order By string $orderBy		Orders results.	displayName desc
Select string $select		Filters properties (columns).	givenName,surname
Skip Token string $skipToken		Retrieves the next page of results from result sets that span multiple pages.	X%274453707402000100000017...
Top string $top		Sets the page size of results.	10
Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Drive or Site ID string driveOrSiteId		The ID of the OneDrive or SharePoint site to list workbooks from.	b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Fetch All boolean fetchAll	false	Set to true to retrieve all results.
List or Item ID string listOrItemId		The ID of the list or item to retrieve.	b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Path string path		The path to the file or folder.	/drive/root:/folder/file.xlsx

Example Payload for List Workbooks

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

List Worksheets

Retrieve a list of worksheet objects. | key: listWorksheets

Input	Default	Notes	Example
Expand string $expand		Retrieves related resources.	members
Filter string $filter		Filters results (rows).	startswith(givenName,'J')
Format string $format		Returns the results in the specified media format.	json
Order By string $orderBy		Orders results.	displayName desc
Search string $search		Returns results based on search criteria.	pizza
Select string $select		Filters properties (columns).	givenName,surname
Skip string $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 string $skipToken		Retrieves the next page of results from result sets that span multiple pages.	X%274453707402000100000017...
Top string $top		Sets the page size of results.	10
Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Drive or Site ID string / Required driveOrSiteId		The ID of the OneDrive or SharePoint site to list workbooks from.	b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Fetch All boolean fetchAll	false	Set to true to retrieve all results.
Workbook ID string / Required workbookId		The ID of the workbook to retrieve.	123456

Example Payload for List Worksheets

{
  "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

Input	Default	Notes	Example
Connection connection / Required connection
Data string data		The HTTP body payload to send to the URL.	{"exampleKey": "Example Data"}
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
File Data string Key Value List fileData		File Data to be sent as a multipart form upload.	[{key: "example.txt", value: "My File Contents"}]
Form Data string Key Value List formData		The Form Data to be sent as a multipart form upload.	[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header string Key Value List headers		A list of headers to send with the request.	User-Agent: curl/7.64.1
Max Retry Count string maxRetries	0	The maximum number of retries to attempt.
Method string / Required method		The HTTP method to use.
Query Parameter string Key Value List queryParams		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 string / Required responseType	json	The type of data you expect in the response. You can request json, text, or binary data.
Retry On All Errors boolean retryAllErrors	false	If true, retries on all erroneous responses regardless of type.
Retry Delay (ms) string retryDelayMS	0	The delay in milliseconds between retries.
Timeout string timeout		The maximum time that a client will await a response to its request	2000
URL string / Required 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 boolean useExponentialBackoff	false	Specifies whether to use a pre-defined exponential backoff strategy for retries.

Read From Buffer

Parse an xlsx file from a Buffer, outputs an array of worksheets | key: parseBuffer

Input	Notes
File string / Required 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

Input	Notes	Example
File URL string / Required fileUrl	The URL of the file to be parsed	https://example.com/file.xlsx

Update Cell Range

Update the properties of range object. | key: updateCellRange

Input	Default	Notes	Example
Address string / Required address		The address of the range to update.	A1:B2
Column Hidden boolean columnHidden	false	Represents if all columns of the current range are hidden.
Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Drive or Site ID string / Required driveOrSiteId		The ID of the OneDrive or SharePoint site to list workbooks from.	b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Formulas code formulas		Represents the formula in A1-style notation.
Formulas Local code formulasLocal		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 code formulasR1C1		Represents the formula in R1C1-style notation.
Number Format code numberFormat		Represents Excel's number format code for the given cell.
Row Hidden boolean rowHidden	false	Represents if all rows of the current range are hidden.
Values code 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 string / Required workbookId		The ID of the workbook that contains the worksheet to update cells from.	123456
Worksheet ID string / Required worksheetId		The ID or name of the worksheet to update cells from.	123456

Example Payload for Update Cell Range

{
  "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

Input	Default	Notes	Example
Column Index string / Required columnId		The id or name of the column to update.	99
Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Drive or Site ID string / Required driveOrSiteId		The ID of the OneDrive or SharePoint site to list workbooks from.	b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Table ID string / Required tableId		The ID or name of the table to update the column from.	66
Values code values		Represents the raw values of the specified range.
Workbook ID string / Required workbookId		The ID of the workbook that contains the worksheet to update the column from.	123456
Worksheet ID string / Required worksheetId		The ID or name of the worksheet to update the column from.	123456

Example Payload for Update Column

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

Update Table

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

Input	Default	Notes	Example
Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Drive or Site ID string / Required driveOrSiteId		The ID of the OneDrive or SharePoint site to list workbooks from.	b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Name string name		The name of the table.	Table1
Show Headers boolean / Required showHeaders	false	Whether to show the headers of the table.
Show Totals boolean / Required showTotals	false	Whether to show the totals of the table.
Style string style		The style of the table.
Table ID string / Required tableId		The ID or name of the table to update.	66
Workbook ID string / Required workbookId		The ID of the workbook that contains the worksheet to update the table from.	123456
Worksheet ID string / Required worksheetId		The ID or name of the worksheet to update the table from.	123456

Example Payload for Update Table

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

Update Worksheet

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

Input	Default	Notes	Example
Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Drive or Site ID string / Required driveOrSiteId		The ID of the OneDrive or SharePoint site to list workbooks from.	b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Worksheet Name string name		The new display name of the worksheet.	Sheet1
Position string position		The zero-based position of the worksheet within the workbook.	0
Worksheet Visibility string visibility		The visibility of the worksheet.
Workbook ID string / Required workbookId		The ID of the workbook that contains the worksheet to update.	123456
Worksheet ID string / Required worksheetId		The ID of the worksheet to update.	123456

Example Payload for Update Worksheet

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

Parse and build .xlsx files (spreadsheets)

Description​

Connections​

OAuth 2.0​

Actions​

Build Spreadsheet​

Build Spreadsheet with Multiple Sheets​

Clear Cell Range​

Create Column​

Create Multiple Rows​

Create Row​

Create Table​

Create Worksheet​

Delete Cell Range​

Delete Column​

Delete Table​

Delete Worksheet​

Get Cell​

Get Cell Range​

Get Column​

Get Table​

Get Worksheet​

List Columns​

List Rows​

List Tables​

List Workbooks​

List Worksheets​

Raw Request​

Read From Buffer​

Read From URL​

Update Cell Range​

Update Column​

Update Table​

Update Worksheet​