Microsoft Excel
API actions for the Microsoft Excel integration.
Microsoft Excel
Manage and edit Excel workbooks stored in OneDrive or SharePoint via Microsoft Graph.
Add worksheet
Add a new worksheet to an Excel workbook.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
item_id | string | Yes | Workbook item ID from OneDrive (e.g., from create_workbook or list_children). |
name | string | Yes | Name for the new worksheet. |
drive_id | string | Yes | Drive ID from OneDrive list_drives. |
Response
{
"id": "sheet2",
"name": "Sheet2"
}Append table rows
Append rows to an existing table in a worksheet.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
item_id | string | Yes | Workbook item ID from OneDrive (e.g., from create_workbook or list_children). |
table_id | string | Yes | Table ID from create_table. |
rows | array | Yes | 2D array of row values to append. |
drive_id | string | Yes | Drive ID from OneDrive list_drives. |
Response
{
"rows_added": 2
}Clear range
Clear the contents of a specified range in a worksheet.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
item_id | string | Yes | Workbook item ID from OneDrive (e.g., from create_workbook or list_children). |
worksheet_id | string | Yes | Worksheet ID from add_worksheet. |
range_address | string | Yes | The range address (e.g., 'A1:D10'). |
drive_id | string | Yes | Drive ID from OneDrive list_drives. |
Response
{
"cleared": true
}Create table
Create a table from a range in a worksheet.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
item_id | string | Yes | Workbook item ID from OneDrive (e.g., from create_workbook or list_children). |
worksheet_id | string | Yes | Worksheet ID from add_worksheet. |
table_name | string | Yes | Name for the new table. |
address | string | Yes | The range address for the table (e.g., 'A1:D10'). |
drive_id | string | Yes | Drive ID from OneDrive list_drives. |
Response
{
"id": "table1",
"name": "Table1"
}Delete worksheet
Delete a worksheet from an Excel workbook.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
item_id | string | Yes | Workbook item ID from OneDrive (e.g., from create_workbook or list_children). |
worksheet_id | string | Yes | Worksheet ID from add_worksheet. |
drive_id | string | Yes | Drive ID from OneDrive list_drives. |
Response
{
"deleted": true
}Get range values
Get the values from a specified range in a worksheet.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
item_id | string | Yes | Workbook item ID from OneDrive (e.g., from create_workbook or list_children). |
worksheet_id | string | Yes | Worksheet ID from add_worksheet. |
range_address | string | Yes | The range address (e.g., 'A1:D10'). |
drive_id | string | Yes | Drive ID from OneDrive list_drives. |
Response
{
"values": [
[
"A1",
"B1"
],
[
"A2",
"B2"
]
]
}List worksheets
List all worksheets in an Excel workbook.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
item_id | string | Yes | Workbook item ID from OneDrive (e.g., from create_workbook or list_children). |
drive_id | string | Yes | Drive ID from OneDrive list_drives. |
Response
{
"worksheets": [
"Sheet1"
]
}Rename worksheet
Rename an existing worksheet in an Excel workbook.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
item_id | string | Yes | Workbook item ID from OneDrive (e.g., from create_workbook or list_children). |
worksheet_id | string | Yes | Worksheet ID from add_worksheet. |
new_name | string | Yes | New name for the worksheet. |
drive_id | string | Yes | Drive ID from OneDrive list_drives. |
Response
{
"name": "RenamedSheet"
}Update range values
Update the values in a specified range in a worksheet.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
item_id | string | Yes | Workbook item ID from OneDrive (e.g., from create_workbook or list_children). |
worksheet_id | string | Yes | Worksheet ID from add_worksheet. |
range_address | string | Yes | The range address (e.g., 'A1:D10'). |
values | array | Yes | 2D array of values to set. |
drive_id | string | Yes | Drive ID from OneDrive list_drives. |
Response
{
"values": [
[
"A1",
"B1"
],
[
"A2",
"B2"
]
]
}