capabilities.work

Discover Workbook Structure

A 5-step recipe with Microsoft Excel. We can help you get access.

Recipe · 5 steps

Discover Workbook Structure

with Microsoft Excel

Inventory the structure of an Excel workbook without modifying it.

  1. Open a workbook session with persistChanges false. A read-only session keeps the discovery pass fast and guarantees nothing is written back.
  2. List every worksheet in the workbook, including position and visibility, so hidden sheets are visible to the caller.
  3. List the structured tables defined on the target worksheet. Tables are the preferred write surface because they carry a header row and grow safely.
  4. List workbook-level named items. Named ranges are the stable way to address data that may move as the sheet is edited.
  5. List the charts already present on the worksheet so a reporting flow does not duplicate a chart that already exists.
What you'll need to have ready
  • itemId: The drive item id of the workbook file in OneDrive or SharePoint.
  • worksheetIdOrName: The worksheet to inspect for tables and charts (e.g. "Sheet1").
For your developer

Arazzo workflow microsoft-excel:discover-workbook-structure, 5 operations: createWorkbookSession → listWorksheets → listTables → listNamedItems → listCharts. Specs on APIs.io.

More recipes with Microsoft Excel

Append a Row to a TableBuild a Chart from a Data RangeFlatten a Table into a Plain RangeCreate a Worksheet and Seed It with DataWrite Through a Named RangeSort, Filter, and Total a Table for ReportingDelete a Table Row by IndexRead, Write, and Verify a Cell RangeAdd and Retire a Table ColumnCalculate with a Workbook Function and Write the Result