Provenance
Freshness & coverage
Methods (54)
excel_call_function
unknownExecute an Excel workbook function with supplied parameters.
EntitiesworkbookInput schema
{ "type": "object", "properties": { "functionName": { "type": "string" }, "parameters": { "type": "object", "properties": {}, "additionalProperties": true }, "itemId": { "type": "string" }, "siteId": { "type": "string" }, "sessionId": { "type": "string" } }, "additionalProperties": false, "required": [ "functionName", "itemId" ] }excel_unmerge_range
unknownUnmerge cells in a specified Excel worksheet range.
EntitiesrangeInput schema
{ "type": "object", "properties": { "worksheetId": { "type": "string" }, "address": { "type": "string" }, "shift": { "oneOf": [ { "type": "string", "enum": [ "Up" ] }, { "type": "string", "enum": [ "Down" ] }, { "type": "string", "enum": [ "Left" ] }, { "type": "string", "enum": [ "Right" ] } ] }, "applyTo": { "oneOf": [ { "type": "string", "enum": [ "All" ] }, { "type": "string", "enum": [ "Formats" ] }, { "type": "string", "enum": [ "Contents" ] } ] }, "itemId": { "type": "string" }, "siteId": { "type": "string" }, "sessionId": { "type": "string" } }, "additionalProperties": false, "required": [ "worksheetId", "address", "itemId" ] }excel_convert_table_to_range
unknownConvert an Excel table into a worksheet range.
Entitiestable, rangeInput schema
{ "type": "object", "properties": { "tableId": { "type": "string" }, "itemId": { "type": "string" }, "siteId": { "type": "string" }, "sessionId": { "type": "string" } }, "additionalProperties": false, "required": [ "tableId", "itemId" ] }excel_protect_workbook
unknownProtect an Excel workbook using specified protection options.
EntitiesworkbookInput schema
{ "type": "object", "properties": { "options": { "type": "object", "properties": {}, "additionalProperties": true }, "itemId": { "type": "string" }, "siteId": { "type": "string" }, "sessionId": { "type": "string" } }, "additionalProperties": false, "required": [ "itemId" ] }excel_unprotect_workbook
unknownRemove protection from an Excel workbook using specified options.
EntitiesworkbookInput schema
{ "type": "object", "properties": { "options": { "type": "object", "properties": {}, "additionalProperties": true }, "itemId": { "type": "string" }, "siteId": { "type": "string" }, "sessionId": { "type": "string" } }, "additionalProperties": false, "required": [ "itemId" ] }excel_protect_worksheet
unknownProtect an Excel worksheet using specified protection options.
EntitiesworksheetInput schema
{ "type": "object", "properties": { "worksheetId": { "type": "string" }, "options": { "type": "object", "properties": {}, "additionalProperties": true }, "itemId": { "type": "string" }, "siteId": { "type": "string" }, "sessionId": { "type": "string" } }, "additionalProperties": false, "required": [ "worksheetId", "itemId" ] }excel_unprotect_worksheet
unknownRemove protection from an Excel worksheet using specified options.
EntitiesworksheetInput schema
{ "type": "object", "properties": { "worksheetId": { "type": "string" }, "options": { "type": "object", "properties": {}, "additionalProperties": true }, "itemId": { "type": "string" }, "siteId": { "type": "string" }, "sessionId": { "type": "string" } }, "additionalProperties": false, "required": [ "worksheetId", "itemId" ] }excel_list_tables
readList tables in an Excel workbook.
Input schema
{ "type": "object", "properties": { "itemId": { "type": "string" }, "siteId": { "type": "string" }, "sessionId": { "type": "string" } }, "additionalProperties": false, "required": [ "itemId" ] }excel_add_table
writeCreate an Excel table from a worksheet range.
Input schema
{ "type": "object", "properties": { "address": { "type": "string" }, "hasHeaders": { "type": "boolean" }, "worksheetId": { "type": "string" }, "itemId": { "type": "string" }, "siteId": { "type": "string" }, "sessionId": { "type": "string" } }, "additionalProperties": false, "required": [ "address", "itemId" ] }excel_list_charts
readList charts on a specified Excel worksheet.
Input schema
{ "type": "object", "properties": { "worksheetIdOrName": { "type": "string" }, "itemId": { "type": "string" }, "siteId": { "type": "string" }, "sessionId": { "type": "string" } }, "additionalProperties": false, "required": [ "worksheetIdOrName", "itemId" ] }excel_get_workbook
readRetrieve an Excel workbook by its storage identifiers.
Input schema
{ "type": "object", "properties": { "itemId": { "type": "string" }, "siteId": { "type": "string" }, "sessionId": { "type": "string" } }, "additionalProperties": false, "required": [ "itemId" ] }excel_close_session
unknownClose an active Excel workbook session.
Input schema
{ "type": "object", "properties": { "sessionId": { "type": "string" }, "itemId": { "type": "string" }, "siteId": { "type": "string" } }, "additionalProperties": false, "required": [ "sessionId", "itemId" ] }excel_refresh_all
unknownRefresh all Excel workbook data connections and calculations.
Input schema
{ "type": "object", "properties": { "itemId": { "type": "string" }, "siteId": { "type": "string" }, "sessionId": { "type": "string" } }, "additionalProperties": false, "required": [ "itemId" ] }excel_get_worksheet
readRetrieve an Excel worksheet by identifier or name.
Input schema
{ "type": "object", "properties": { "worksheetIdOrName": { "type": "string" }, "itemId": { "type": "string" }, "siteId": { "type": "string" }, "sessionId": { "type": "string" } }, "additionalProperties": false, "required": [ "worksheetIdOrName", "itemId" ] }excel_add_worksheet
writeCreate a worksheet in an Excel workbook.
Input schema
{ "type": "object", "properties": { "name": { "type": "string" }, "itemId": { "type": "string" }, "siteId": { "type": "string" }, "sessionId": { "type": "string" } }, "additionalProperties": false, "required": [ "itemId" ] }excel_delete_worksheet
writeDelete a specified worksheet from an Excel workbook.
Input schema
{ "type": "object", "properties": { "worksheetId": { "type": "string" }, "itemId": { "type": "string" }, "siteId": { "type": "string" }, "sessionId": { "type": "string" } }, "additionalProperties": false, "required": [ "worksheetId", "itemId" ] }excel_activate_worksheet
unknownActivate an Excel worksheet by identifier or name.
Input schema
{ "type": "object", "properties": { "worksheetIdOrName": { "type": "string" }, "itemId": { "type": "string" }, "siteId": { "type": "string" }, "sessionId": { "type": "string" } }, "additionalProperties": false, "required": [ "worksheetIdOrName", "itemId" ] }excel_get_used_range
readRetrieve the used cell range from an Excel worksheet.
Input schema
{ "type": "object", "properties": { "worksheetId": { "type": "string" }, "valuesOnly": { "type": "boolean" }, "itemId": { "type": "string" }, "siteId": { "type": "string" }, "sessionId": { "type": "string" } }, "additionalProperties": false, "required": [ "worksheetId", "itemId" ] }excel_get_named_range
readRetrieve an Excel named range by name.
Input schema
{ "type": "object", "properties": { "name": { "type": "string" }, "itemId": { "type": "string" }, "siteId": { "type": "string" }, "sessionId": { "type": "string" } }, "additionalProperties": false, "required": [ "name", "itemId" ] }excel_clear_range
unknownClear cells in a specified Excel worksheet range.
Input schema
{ "type": "object", "properties": { "worksheetId": { "type": "string" }, "address": { "type": "string" }, "shift": { "oneOf": [ { "type": "string", "enum": [ "Up" ] }, { "type": "string", "enum": [ "Down" ] }, { "type": "string", "enum": [ "Left" ] }, { "type": "string", "enum": [ "Right" ] } ] }, "applyTo": { "oneOf": [ { "type": "string", "enum": [ "All" ] }, { "type": "string", "enum": [ "Formats" ] }, { "type": "string", "enum": [ "Contents" ] } ] }, "itemId": { "type": "string" }, "siteId": { "type": "string" }, "sessionId": { "type": "string" } }, "additionalProperties": false, "required": [ "worksheetId", "address", "itemId" ] }excel_insert_range
writeInsert cells into a specified Excel worksheet range.
Input schema
{ "type": "object", "properties": { "worksheetId": { "type": "string" }, "address": { "type": "string" }, "shift": { "oneOf": [ { "type": "string", "enum": [ "Up" ] }, { "type": "string", "enum": [ "Down" ] }, { "type": "string", "enum": [ "Left" ] }, { "type": "string", "enum": [ "Right" ] } ] }, "applyTo": { "oneOf": [ { "type": "string", "enum": [ "All" ] }, { "type": "string", "enum": [ "Formats" ] }, { "type": "string", "enum": [ "Contents" ] } ] }, "itemId": { "type": "string" }, "siteId": { "type": "string" }, "sessionId": { "type": "string" } }, "additionalProperties": false, "required": [ "worksheetId", "address", "itemId" ] }excel_delete_range
writeDelete cells from a specified Excel worksheet range.
Input schema
{ "type": "object", "properties": { "worksheetId": { "type": "string" }, "address": { "type": "string" }, "shift": { "oneOf": [ { "type": "string", "enum": [ "Up" ] }, { "type": "string", "enum": [ "Down" ] }, { "type": "string", "enum": [ "Left" ] }, { "type": "string", "enum": [ "Right" ] } ] }, "applyTo": { "oneOf": [ { "type": "string", "enum": [ "All" ] }, { "type": "string", "enum": [ "Formats" ] }, { "type": "string", "enum": [ "Contents" ] } ] }, "itemId": { "type": "string" }, "siteId": { "type": "string" }, "sessionId": { "type": "string" } }, "additionalProperties": false, "required": [ "worksheetId", "address", "itemId" ] }excel_merge_range
unknownMerge cells in a specified Excel worksheet range.
Input schema
{ "type": "object", "properties": { "worksheetId": { "type": "string" }, "address": { "type": "string" }, "shift": { "oneOf": [ { "type": "string", "enum": [ "Up" ] }, { "type": "string", "enum": [ "Down" ] }, { "type": "string", "enum": [ "Left" ] }, { "type": "string", "enum": [ "Right" ] } ] }, "applyTo": { "oneOf": [ { "type": "string", "enum": [ "All" ] }, { "type": "string", "enum": [ "Formats" ] }, { "type": "string", "enum": [ "Contents" ] } ] }, "itemId": { "type": "string" }, "siteId": { "type": "string" }, "sessionId": { "type": "string" } }, "additionalProperties": false, "required": [ "worksheetId", "address", "itemId" ] }excel_get_table
readRetrieve an Excel table by identifier or name.
Input schema
{ "type": "object", "properties": { "tableIdOrName": { "type": "string" }, "itemId": { "type": "string" }, "siteId": { "type": "string" }, "sessionId": { "type": "string" } }, "additionalProperties": false, "required": [ "tableIdOrName", "itemId" ] }excel_delete_table
writeDelete a specified Excel table.
Input schema
{ "type": "object", "properties": { "tableId": { "type": "string" }, "itemId": { "type": "string" }, "siteId": { "type": "string" }, "sessionId": { "type": "string" } }, "additionalProperties": false, "required": [ "tableId", "itemId" ] }excel_clear_table
unknownClear data from a specified Excel table.
Input schema
{ "type": "object", "properties": { "tableId": { "type": "string" }, "itemId": { "type": "string" }, "siteId": { "type": "string" }, "sessionId": { "type": "string" } }, "additionalProperties": false, "required": [ "tableId", "itemId" ] }excel_list_table_rows
readList rows in a specified Excel table.
Input schema
{ "type": "object", "properties": { "tableId": { "type": "string" }, "itemId": { "type": "string" }, "siteId": { "type": "string" }, "sessionId": { "type": "string" } }, "additionalProperties": false, "required": [ "tableId", "itemId" ] }excel_add_table_rows
writeAdd rows to an Excel table at an optional index.
Input schema
{ "type": "object", "properties": { "tableId": { "type": "string" }, "values": { "type": "array", "items": { "type": "array", "items": {} } }, "index": { "type": "number" }, "itemId": { "type": "string" }, "siteId": { "type": "string" }, "sessionId": { "type": "string" } }, "additionalProperties": false, "required": [ "tableId", "values", "itemId" ] }excel_delete_table_row
writeDelete a specified row from an Excel table.
Input schema
{ "type": "object", "properties": { "tableId": { "type": "string" }, "rowIndex": { "type": "number" }, "itemId": { "type": "string" }, "siteId": { "type": "string" }, "sessionId": { "type": "string" } }, "additionalProperties": false, "required": [ "tableId", "rowIndex", "itemId" ] }excel_list_table_columns
readList columns in a specified Excel table.
Input schema
{ "type": "object", "properties": { "tableId": { "type": "string" }, "itemId": { "type": "string" }, "siteId": { "type": "string" }, "sessionId": { "type": "string" } }, "additionalProperties": false, "required": [ "tableId", "itemId" ] }excel_add_table_column
writeAdd a column to an Excel table with optional values.
Input schema
{ "type": "object", "properties": { "tableId": { "type": "string" }, "name": { "type": "string" }, "values": { "type": "array", "items": { "type": "array", "items": {} } }, "index": { "type": "number" }, "itemId": { "type": "string" }, "siteId": { "type": "string" }, "sessionId": { "type": "string" } }, "additionalProperties": false, "required": [ "tableId", "itemId" ] }excel_delete_table_column
writeDelete a specified column from an Excel table.
Input schema
{ "type": "object", "properties": { "tableId": { "type": "string" }, "columnId": { "type": "string" }, "itemId": { "type": "string" }, "siteId": { "type": "string" }, "sessionId": { "type": "string" } }, "additionalProperties": false, "required": [ "tableId", "columnId", "itemId" ] }excel_get_chart
readRetrieve an Excel chart by worksheet and chart name.
Input schema
{ "type": "object", "properties": { "worksheetId": { "type": "string" }, "chartName": { "type": "string" }, "itemId": { "type": "string" }, "siteId": { "type": "string" }, "sessionId": { "type": "string" } }, "additionalProperties": false, "required": [ "worksheetId", "chartName", "itemId" ] }excel_add_chart
writeCreate an Excel chart from specified worksheet source data.
Input schema
{ "type": "object", "properties": { "worksheetId": { "type": "string" }, "type": { "type": "string" }, "sourceData": { "type": "string" }, "seriesBy": { "oneOf": [ { "type": "string", "enum": [ "Auto" ] }, { "type": "string", "enum": [ "Rows" ] }, { "type": "string", "enum": [ "Columns" ] } ] }, "itemId": { "type": "string" }, "siteId": { "type": "string" }, "sessionId": { "type": "string" } }, "additionalProperties": false, "required": [ "worksheetId", "type", "sourceData", "itemId" ] }excel_delete_chart
writeRemove one chart object from a workbook, leaving its source data intact.
Input schema
{ "type": "object", "properties": { "worksheetId": { "type": "string" }, "chartName": { "type": "string" }, "itemId": { "type": "string" }, "siteId": { "type": "string" }, "sessionId": { "type": "string" } }, "additionalProperties": false, "required": [ "worksheetId", "chartName", "itemId" ] }excel_set_chart_position
writeSet an Excel chart position between specified worksheet cells.
Input schema
{ "type": "object", "properties": { "worksheetId": { "type": "string" }, "chartName": { "type": "string" }, "startCell": { "type": "string" }, "endCell": { "type": "string" }, "itemId": { "type": "string" }, "siteId": { "type": "string" }, "sessionId": { "type": "string" } }, "additionalProperties": false, "required": [ "worksheetId", "chartName", "itemId" ] }excel_list_pivot_tables
readList pivot tables on a specified Excel worksheet.
Input schema
{ "type": "object", "properties": { "worksheetIdOrName": { "type": "string" }, "itemId": { "type": "string" }, "siteId": { "type": "string" }, "sessionId": { "type": "string" } }, "additionalProperties": false, "required": [ "worksheetIdOrName", "itemId" ] }excel_get_pivot_table
readRetrieve an Excel pivot table by worksheet and name.
Input schema
{ "type": "object", "properties": { "worksheetId": { "type": "string" }, "pivotName": { "type": "string" }, "itemId": { "type": "string" }, "siteId": { "type": "string" }, "sessionId": { "type": "string" } }, "additionalProperties": false, "required": [ "worksheetId", "pivotName", "itemId" ] }excel_add_pivot_table
writeCreate an Excel pivot table from source data at a destination.
Input schema
{ "type": "object", "properties": { "worksheetId": { "type": "string" }, "name": { "type": "string" }, "sourceData": { "type": "string" }, "destination": { "type": "string" }, "itemId": { "type": "string" }, "siteId": { "type": "string" }, "sessionId": { "type": "string" } }, "additionalProperties": false, "required": [ "worksheetId", "name", "sourceData", "destination", "itemId" ] }excel_refresh_pivot_table
unknownRefresh a specified Excel pivot table.
Input schema
{ "type": "object", "properties": { "worksheetId": { "type": "string" }, "pivotName": { "type": "string" }, "itemId": { "type": "string" }, "siteId": { "type": "string" }, "sessionId": { "type": "string" } }, "additionalProperties": false, "required": [ "worksheetId", "pivotName", "itemId" ] }excel_list_names
readList defined names in an Excel workbook.
Input schema
{ "type": "object", "properties": { "itemId": { "type": "string" }, "siteId": { "type": "string" }, "sessionId": { "type": "string" } }, "additionalProperties": false, "required": [ "itemId" ] }excel_get_name
readRetrieve an Excel defined name by name.
Input schema
{ "type": "object", "properties": { "name": { "type": "string" }, "itemId": { "type": "string" }, "siteId": { "type": "string" }, "sessionId": { "type": "string" } }, "additionalProperties": false, "required": [ "name", "itemId" ] }excel_add_name
writeCreate an Excel defined name referencing a specified range.
Input schema
{ "type": "object", "properties": { "name": { "type": "string" }, "reference": { "type": "string" }, "comment": { "type": "string" }, "itemId": { "type": "string" }, "siteId": { "type": "string" }, "sessionId": { "type": "string" } }, "additionalProperties": false, "required": [ "name", "reference", "itemId" ] }excel_delete_name
writeDelete a specified Excel defined name.
Input schema
{ "type": "object", "properties": { "name": { "type": "string" }, "itemId": { "type": "string" }, "siteId": { "type": "string" }, "sessionId": { "type": "string" } }, "additionalProperties": false, "required": [ "name", "itemId" ] }excel_list_comments
readList comments in an Excel workbook.
Input schema
{ "type": "object", "properties": { "itemId": { "type": "string" }, "siteId": { "type": "string" }, "sessionId": { "type": "string" } }, "additionalProperties": false, "required": [ "itemId" ] }excel_get_comment
readRetrieve an Excel comment by its identifier.
Input schema
{ "type": "object", "properties": { "commentId": { "type": "string" }, "itemId": { "type": "string" }, "siteId": { "type": "string" }, "sessionId": { "type": "string" } }, "additionalProperties": false, "required": [ "commentId", "itemId" ] }excel_add_comment
writeAdd a comment to a specified Excel worksheet cell.
Input schema
{ "type": "object", "properties": { "cellAddress": { "type": "string" }, "content": { "type": "string" }, "worksheetId": { "type": "string" }, "itemId": { "type": "string" }, "siteId": { "type": "string" }, "sessionId": { "type": "string" } }, "additionalProperties": false, "required": [ "cellAddress", "content", "itemId" ] }excel_delete_comment
writeDelete a specified Excel comment.
Input schema
{ "type": "object", "properties": { "commentId": { "type": "string" }, "itemId": { "type": "string" }, "siteId": { "type": "string" }, "sessionId": { "type": "string" } }, "additionalProperties": false, "required": [ "commentId", "itemId" ] }excel_get_application
readRetrieve the Excel application for a workbook session.
Input schema
{ "type": "object", "properties": { "itemId": { "type": "string" }, "siteId": { "type": "string" }, "sessionId": { "type": "string" } }, "additionalProperties": false, "required": [ "itemId" ] }excel_calculate_application
readCalculate an Excel application using the specified calculation type.
Input schema
{ "type": "object", "properties": { "calculationType": { "oneOf": [ { "type": "string", "enum": [ "Recalculate" ] }, { "type": "string", "enum": [ "Full" ] }, { "type": "string", "enum": [ "FullRebuild" ] } ] }, "itemId": { "type": "string" }, "siteId": { "type": "string" }, "sessionId": { "type": "string" } }, "additionalProperties": false, "required": [ "itemId" ] }excel_create_session
writeCreate a workbook session for long-running Excel operations.
Required paramsitemIdInput schema
{ "type": "object", "properties": { "persistChanges": { "type": "boolean", "description": "Persist workbook changes." }, "itemId": { "type": "string", "description": "Workbook drive item ID." }, "siteId": { "type": "string", "description": "Optional SharePoint site ID." }, "sessionId": { "type": "string" } }, "additionalProperties": true, "required": [ "itemId" ] }excel_list_worksheets
readList worksheets in a workbook.
Required paramsitemIdInput schema
{ "type": "object", "properties": { "itemId": { "type": "string", "description": "Workbook drive item ID." }, "siteId": { "type": "string", "description": "Optional SharePoint site ID." }, "sessionId": { "type": "string", "description": "Workbook session ID." } }, "additionalProperties": true, "required": [ "itemId" ] }excel_get_range
readRead a worksheet range using A1 notation.
Required paramsitemIdworksheetIdaddressInput schema
{ "type": "object", "properties": { "worksheetId": { "type": "string", "description": "Worksheet ID or name." }, "address": { "type": "string", "description": "A1-style address, e.g. A1:B10." }, "itemId": { "type": "string", "description": "Workbook drive item ID." }, "siteId": { "type": "string", "description": "Optional SharePoint site ID." }, "sessionId": { "type": "string", "description": "Workbook session ID." } }, "additionalProperties": true, "required": [ "itemId", "worksheetId", "address" ] }excel_update_range
writeWrite values into a worksheet range.
Required paramsitemIdworksheetIdaddressvaluesInput schema
{ "type": "object", "properties": { "worksheetId": { "type": "string", "description": "Worksheet ID or name." }, "address": { "type": "string", "description": "A1-style address." }, "values": { "type": "array", "items": { "type": "array", "items": {} }, "description": "2D array of values to write." }, "formulas": { "type": "array", "items": { "type": "array", "items": {} } }, "numberFormat": { "type": "array", "items": { "type": "array", "items": {} } }, "itemId": { "type": "string", "description": "Workbook drive item ID." }, "siteId": { "type": "string", "description": "Optional SharePoint site ID." }, "sessionId": { "type": "string", "description": "Workbook session ID." } }, "additionalProperties": true, "required": [ "itemId", "worksheetId", "address", "values" ] }
