Spreadsheets

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.

Spreadsheet

Properties

Name	Type	Description	Restrictions
created	Action	When the action was performed, and details about the user who did it	read-only
id	string	The unique identifier of the spreadsheet	read-only
modified	Action	When the action was performed, and details about the user who did it	read-only
name	string	The name of the spreadsheet	read-only
sheets	[Sheet]	An array of partial information about the sheets in this spreadsheet. Optionally included in the response when the $expand query parameter is provided.	read-only
template	boolean	Whether the spreadsheet is a template	read-only

Example

{
  "created": {
    "dateTime": "2019-10-30T15:03:27Z",
    "user": {
      "displayName": "string",
      "email": "string",
      "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD"
    }
  },
  "id": "124efa2a142f472ba1ceab34ed18915f",
  "modified": {
    "dateTime": "2019-10-30T15:03:27Z",
    "user": {
      "displayName": "string",
      "email": "string",
      "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD"
    }
  },
  "name": "Year-end review",
  "sheets": [
    {
      "id": "27f1b61c04ae4b0991bc73c631914e1d",
      "name": "Q1"
    }
  ],
  "template": false
}

SpreadsheetExport

Properties

Name	Type	Description
csvOptions	SpreadsheetToCsvOptions¦null	Optional options to export the spreadsheet as a comma-separated values (.CSV) file. If no options are provided, `exportAsFormulas` defaults to False.
format	string	The file format to export the spreadsheet as.
pdfOptions	SpreadsheetToPdfOptions¦null	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.
xlsxOptions	SpreadsheetToXlsxOptions¦null	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`.

Enumerated Values

Property	Value
format	`pdf`
format	`xlsx`
format	`csv`

Example

{
  "format": "xlsx",
  "sheets": [
    "7c8d8c4a46784455bg68t36f9d8232d8",
    "54bgd83b471e5902f1a8e8c9a299c9fb"
  ],
  "xlsxOptions": {
    "exportAsFormulas": true,
    "exportPrecision": "displayed"
  }
}

SpreadsheetToPdfOptions

Properties

Name	Type	Description
includeComments	boolean	Whether to include comments when exporting to .PDF False by default.
includeDraftWatermark	boolean	Whether to include draft watermark when exporting to .PDF. False by default.
includeHyperlinks	boolean	Whether to include hyperlinks when exporting to .PDF. False by default.
includeLeaderDots	boolean	Whether to include leader dots when exporting to .PDF. False by default.
includeTrackChanges	boolean	Whether to include track changes when exporting to .PDF. False by default.
onlyExportPrintAreas	boolean	Whether to only export print areas when exporting to .PDF. False by default.
pageHeight	number(double)	The height of the exported .PDF, in inches. 11 by default.
pageOrientation	string	The orientation of the exported .PDF, such as "portrait" or "landscape". "portrait" by default.
pageScale	string	The scale of the exported .PDF. "actualSize" by default.
pageWidth	number(double)	The width of the exported .PDF, in inches. 8.5 by default.
showCellFills	boolean	Whether to show cell fills when exporting to .PDF. False by default.
showGridlines	boolean	Whether to show gridlines when exporting to .PDF. False by default.
useCmykColorspace	boolean	Whether to use CMYK colorspace when exporting to .PDF. False by default.

Enumerated Values

Property	Value
pageOrientation	`portrait`
pageOrientation	`landscape`
pageScale	`actualSize`
pageScale	`fitToWidth`

Example

{
  "includeComments": true,
  "includeDraftWatermark": true,
  "includeHyperlinks": true,
  "includeLeaderDots": true,
  "includeTrackChanges": true,
  "onlyExportPrintAreas": true,
  "pageHeight": 14,
  "pageOrientation": "landscape",
  "pageScale": "fitToWidth",
  "pageWidth": 11,
  "showCellFills": true,
  "showGridlines": true,
  "useCmykColorspace": true
}

SpreadsheetToXlsxOptions

Properties

Name	Type	Description	Restrictions
exportAsFormulas	boolean	Whether to export cells that contain formulas as the formula or its result when exporting to .XLSX. False by default.
exportPrecision	string	How to export values in the sheet when exporting to .XLSX "fullPrecision" by default.

Enumerated Values

Property	Value
exportPrecision	`fullPrecision`
exportPrecision	`rounded`
exportPrecision	`displayed`

Example

{
  "exportAsFormulas": true,
  "exportPrecision": "displayed"
}

SpreadsheetToCsvOptions

Properties

Name	Type	Description	Restrictions
exportAsFormulas	boolean	Whether to export cells containing formulas as the formula or the formula result. False by default.

Example

{
  "exportAsFormulas": true
}

Sheet

Properties

Name	Type	Description	Restrictions
children	[Sheet]	An array of partial information about any child sheets	read-only
dataset	Dataset¦null	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.
name	string	The name of the sheet
parent	Sheet¦null	The sheet's ID and name

Example

{
  "children": [
    {
      "id": "27f1b61c04ae4b0991bc73c631914e1d",
      "name": "Q1"
    }
  ],
  "dataset": {
    "range": "A1:B2"
  },
  "id": "27f1b61c04ae4b0991bc73c631914e1d",
  "index": 1,
  "name": "Q1",
  "parent": {
    "id": "27f1b61c04ae4b0991bc73c631914e1d",
    "name": "Q1"
  }
}

SheetCopy

Properties

Name	Type	Description
sheetIndex	integer	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

Example

{
  "sheetIndex": 2,
  "sheetName": "Q1",
  "sheetParent": "5bbf8aa3cea54465762af96e3ca411c7",
  "spreadsheet": "c65d9572a7464037a383d6235633cf74"
}

Dataset

Properties

Name	Type	Description	Restrictions
range	string	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.

Example

{
  "range": "A1:B2",
  "sheet": "27f1b61c04ae4b0991bc73c631914e1d",
  "values": [
    [
      1,
      4
    ],
    [
      2,
      ""
    ]
  ]
}

Datasets

Properties

Name	Type	Description	Restrictions
	[Dataset]	An array of Datasets to submit at once

Example

[
  {
    "range": "A1:B2",
    "sheet": "27f1b61c04ae4b0991bc73c631914e1d",
    "values": [
      [
        1,
        4
      ],
      [
        2,
        ""
      ]
    ]
  }
]

RangeValues

Properties

Name	Type	Description	Restrictions
range	string	The range of values, in A1-style notation.
values	[array]	A row-major ordered multidimensional array of cell values.

Example

{
  "range": "A1:B2",
  "values": [
    [
      1,
      4
    ],
    [
      2,
      ""
    ]
  ]
}