Synology Sheets icon

Synology Sheets

Create, read, write, and manage Synology spreadsheets via Docker API

Export Sheet as CSV

AI-generated

Summary

Export a specific sheet from a Synology spreadsheet as a CSV file and return the CSV data as binary in the output.

Inputs

  • Spreadsheet ID (required) — ID of the spreadsheet to export from.
  • Sheet Name — Name of the sheet within the spreadsheet to export as CSV; defaults to 'Sheet1' if not specified.
  • Binary Field Name — The name of the binary field in the output item to store the CSV data; defaults to 'data'.

Output shape

a list of items each containing JSON metadata about the CSV file (including filename, size, mimetype, success status) and binary data of the CSV encoded in base64 under the specified binary field name.

The binary data is the CSV file content for the specified sheet. The operation requires valid Synology spreadsheet API credentials. If multiple input items are processed, each will produce a corresponding output item with CSV data.

Examples

Example 1: Export the 'Sheet1' sheet from a given spreadsheet by ID and store the CSV data in a binary field named 'data'.

Set 'Spreadsheet ID' to the target spreadsheet's ID, optionally set 'Sheet Name' to the desired sheet to export (default is 'Sheet1'), and specify the binary field to store the CSV data.

Links

Discussion