Spreadsheets enable you to work with large, complex data in a familiar, collaborative, and controlled environment. Use these endpoints to manage spreadsheets and their sheets in the Workiva platform.
An array of partial information about the sheets in this spreadsheet. Optionally included in the response when the $expand query parameter is provided.
Optional options to export the spreadsheet as a portable document file (.PDF). If no options are provided, all options default to False except: - pageHeight, which defaults to 11 - pageWidth, which defaults to 8.5 - pageOrientation, which defaults to "portrait" - pageScale, which defaults to "actualSize"
sheets
[string]
The IDs of the sheets within the spreadsheet to export. Omit to export the entire spreadsheet.
Note: When exporting to .CSV, you can export only the entire spreadsheet or a single sheet. When exporting the entire spreadsheet, the resulting file is a .ZIP of .CSV files, with one .CSV file per sheet.
Optional options to export the spreadsheet as a Microsoft Excel (.XLSX) file. If no options are provided, exportAsFormulas defaults to False, and exportPrecision defaults to fullPrecision.
The range of the dataset on this sheet, if one exists. * To modify a dataset, either update or delete it.
read-only
id
string
The unique identifier of the sheet
read-only
index
integer
The integer index of the sheet relative to its parent sheet or to the spreadsheet, if no parent sheet. To position a sheet at the end of its siblings, use the special value -1.
The integer index of where within the siblings to place the new sheet; 0 by default. To place the sheet at the end of its siblings, use the special value -1.
sheetName
string¦null
The name of the new sheet, if different than the source sheet.
sheetParent
string¦null
The ID of the parent sheet to copy the sheet into. To place the sheet at the top level of the spreadsheet, use the default null.
spreadsheet
string
The unique identifier of the spreadsheet to copy a sheet into
A1 style notation describing the range. Datasets are always located in the top left-hand corner of the sheet, so there is no need to specify range when creating a dataset.
read-only
sheet
string
The unique identifier of the sheet to which this dataset belongs.
values
[array]
A row-major ordered multidimensional array of cell values.