Synology Office icon

Synology Office

Synology Office / Spreadsheet helper node

Actions8

Get Sheet Metadata

AI-generated

Summary

Retrieve metadata about a specific sheet within a Synology Office spreadsheet file by specifying its file and sheet IDs, optionally including extra parameters to customize the API call.

Inputs

  • Spreadsheet File ID (required) — The unique identifier of the spreadsheet file from which to retrieve sheet metadata.
  • Sheet ID — The identifier of the specific sheet within the spreadsheet whose metadata you want to fetch. If omitted, the call may retrieve metadata for the default or all sheets depending on the API behavior.
  • Extra Params (JSON) — Optional JSON object with additional parameters to be merged into the API call, useful if your DSM environment uses different parameter names or requires extra settings.

Output shape

a JSON object containing the metadata details of the specified sheet within the spreadsheet file

The response contains whatever metadata fields are returned by one of the Synology Office APIs ('get', 'info', or 'load' methods on SYNO.Office.Sheet, SYNO.Office.Node, or SYNO.Office.File); errors are thrown if the API call fails. This output is provided as a single item per input item.

Examples

Example 1: Getting metadata for a particular sheet

Set 'Spreadsheet File ID' to the target file's ID and 'Sheet ID' to the relevant sheet's ID; optionally supply 'Extra Params (JSON)' for any custom parameters your DSM requires.

Links

Discussion