capabilities.work

Scratch Worksheet Lifecycle

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

Recipe · 5 steps

Scratch Worksheet Lifecycle

with Microsoft Excel

Exercise create, get, update, and delete against a single scratch worksheet.

  1. Open a persisting session so each mutation in the lifecycle is committed and observable by the next step.
  2. Create the scratch worksheet and capture the id Excel assigns to it.
  3. Fetch the worksheet by the id returned at creation to confirm it exists and to capture its starting position and visibility.
  4. Patch the worksheet's name and position. Excel applies both properties in a single PATCH and returns the updated worksheet.
  5. Remove the scratch worksheet, leaving the workbook as it was found. This is destructive and cannot be undone through the API.
What you'll need to have ready
  • itemId: The drive item id of the workbook file.
  • worksheetName: The name to give the scratch worksheet on creation.
  • renamedWorksheetName: The name to rename the worksheet to during the update step.
  • position: The zero-based position to move the worksheet to.
For your developer

Arazzo workflow microsoft-excel:worksheet-lifecycle, 5 operations: createWorkbookSession → createWorksheet → getWorksheet → updateWorksheet → deleteWorksheet. 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 DataDiscover Workbook StructureWrite 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 Column