Skip to main content
Server path: /microsoft-excel | Type: Application | PCID required: Yes Workbook and worksheet operations

​
Tools

ToolDescription
microsoft-excel_create_workbookCreate new Microsoft Excel workbook
microsoft-excel_create_worksheetCreate new worksheet in Microsoft Excel workbook
microsoft-excel_list_workbooksList Microsoft Excel workbooks from the root directory or a specific folder
microsoft-excel_list_worksheetsList Microsoft Excel worksheets in a workbook
microsoft-excel_read_dataRead data from Microsoft Excel worksheet
microsoft-excel_write_dataWrite data to Microsoft Excel worksheet
microsoft-excel_rename_worksheetRename worksheet in Microsoft Excel workbook
microsoft-excel_get_workbook_metadataGet metadata about workbook including sheets, ranges, etc.
microsoft-excel_delete_worksheetDelete worksheet from Microsoft Excel workbook
microsoft-excel_delete_workbookDelete a Microsoft Excel workbook

​
microsoft-excel_create_workbook

Create new Microsoft Excel workbook Parameters:
ParameterTypeRequiredDefaultDescription
fileNamestringYes—Name of the new workbook file

​
microsoft-excel_create_worksheet

Create new worksheet in Microsoft Excel workbook Parameters:
ParameterTypeRequiredDefaultDescription
workbookIdstringYes—Workbook ID to create the worksheet in
sheetNamestringYes—Name of the new worksheet

​
microsoft-excel_list_workbooks

List Microsoft Excel workbooks from the root directory or a specific folder Parameters:
ParameterTypeRequiredDefaultDescription
driveIdstringNo—Optional drive ID to list workbooks from a specific folder

​
microsoft-excel_list_worksheets

List Microsoft Excel worksheets in a workbook Parameters:
ParameterTypeRequiredDefaultDescription
workbookIdstringYes—Workbook ID to list worksheets from

​
microsoft-excel_read_data

Read data from Microsoft Excel worksheet Parameters:
ParameterTypeRequiredDefaultDescription
workbookIdstringYes—Workbook ID to read data from
sheetNamestringYes—Worksheet name to read data from
startCellstringNo"A1"Starting cell of the range to read (defaults to “A1”)
endCellstringNo—Ending cell of the range to read (e.g., “B10”)

​
microsoft-excel_write_data

Write data to Microsoft Excel worksheet Parameters:
ParameterTypeRequiredDefaultDescription
workbookIdstringYes—Workbook ID to write data to
sheetNamestringYes—Worksheet name to write data to
datastring[][]Yes—Array of rows
startCellstringNo"A1"Starting cell where data will be written (defaults to “A1”)

​
microsoft-excel_rename_worksheet

Rename worksheet in Microsoft Excel workbook Parameters:
ParameterTypeRequiredDefaultDescription
workbookIdstringYes—Workbook ID containing the worksheet to rename
oldNamestringYes—Current name of the worksheet
newNamestringYes—New name for the worksheet

​
microsoft-excel_get_workbook_metadata

Get metadata about workbook including sheets, ranges, etc. Parameters:
ParameterTypeRequiredDefaultDescription
workbookIdstringYes—Workbook ID to get metadata for
includeRangesbooleanNofalseWhether to include named ranges in the metadata

​
microsoft-excel_delete_worksheet

Delete worksheet from Microsoft Excel workbook Parameters:
ParameterTypeRequiredDefaultDescription
workbookIdstringYes—Workbook ID containing the worksheet to delete
sheetNamestringYes—Name of the worksheet to delete

​
microsoft-excel_delete_workbook

Delete a Microsoft Excel workbook Parameters:
ParameterTypeRequiredDefaultDescription
workbookIdstringYes—ID of the workbook to delete