GetWorkbook
Contents
[
Hide
]
GetWorkbook
Retrieve workbooks in various formats.
REST API
API | HttpMethod | Description | API reference |
---|---|---|---|
/cells/{name} | GET | Retrieve workbooks in various formats. | GetWorkbook |
Path Parameter
Parameter Name | Type | Description |
---|---|---|
name | string | The file name. |
Query Parameter
Parameter Name | Type | Description | ||
---|---|---|---|---|
format | string | The conversion format(CSV/XLS/HTML/MHTML/ODS/PDF/XML/TXT/TIFF/XLSB/XLSM/XLSX/XLTM/XLTX/XPS/PNG/JPG/JPEG/GIF/EMF/BMP/MD[Markdown]/Numbers). | ||
password | string | The password needed to open an Excel file. | ||
isAutoFit | boolean | Specifies whether set workbook rows to be autofit. | ||
onlySaveTable | boolean | Specifies whether only save table data.Only use pdf to excel. | ||
folder | string | The folder where the file is situated. | ||
outPath | string | Path to save the result. If it's a single file | the `outPath` should encompass both the filename and extension. In the case of multiple files | the `outPath` should only include the folder. |
storageName | string | The storage name where the file is situated. | ||
outStorageName | string | The storage name where the output file is situated. | ||
checkExcelRestriction | boolean | Whether check restriction of excel file when user modify cells related objects. | ||
region | string | The regional settings for workbook. | ||
pageWideFitOnPerSheet | boolean | The page wide fit on worksheet. | ||
pageTallFitOnPerSheet | boolean | The page tall fit on worksheet. |