LegacySpreadsheets

Use these endpoints to create, update, and fetch data from spreadsheets in the Workiva platform. All calls to the Workiva Spreadsheets API may return a message and request_id as part of the JSON response. If present, message contains a human readable descriptions of the response condition. request_id is a unique identifier for the request.

EmptyResponse

Properties

Name	Type	Description	Restrictions
message	string
request_id	string		required

Example

{
  "message": "Operation successful",
  "request_id": "d6a6ce3f-f120-4104-9587-a5a2dc45626c"
}

Error

Properties

Name	Type	Description	Restrictions
code	string	Error code to assist with diagnosing problems.
field	string	Target field of a specific error.
resource	string	Target resource of a specific error.

Example

{
  "code": "already_exists",
  "field": "name",
  "resource": "spreadsheet"
}

ErrorResponseSpreadsheets

An ErrorResponse object containing a message and list of errors.

Properties

Name	Type	Description	Restrictions
errors	[Error]	A list of errors detailing the resource, field, and error code to aid clients in diagnosing problems.
message	string	Human readable description of the response
request_id	string	A unique identifier for the request
version	string	The API version used to process the request

Example

{
  "errors": [
    {
      "code": "already_exists",
      "field": "name",
      "resource": "spreadsheet"
    }
  ],
  "message": "Invalid request",
  "request_id": "d6a6ce3f-f120-4104-9587-a5a2dc45626c",
  "version": "2022-01-01"
}

LegacyRangeValues

Row-major ordered multidimensional array of cell values

Properties

Name	Type	Description	Restrictions
anonymous	[RowValues]	Row-major ordered multidimensional array of cell values

Example

[
  [
    "Row1-Column1 Data",
    "Row1-Column2 Data"
  ],
  [
    "Row2-Column1 Data",
    "Row2-Column2 Data"
  ]
]

LegacySheet

Properties

Name	Type	Description	Restrictions
child_ids	[string]	Array of unique identifiers for the child sheets of the sheet. This will be empty if the sheet has no children in the spreadsheet outline.
id	string	Unique identifier for the sheet
index	integer	Zero-based index specifying the position of this sheet in relation to sibling sheets
input_mode	boolean¦null	Indicates whether the sheet is in input mode
locked	boolean¦null	Indicates whether the sheet is locked from editing
name	string	Display name for the sheet
parent_id	string	Unique identifier for the parent sheet of the sheet. This will be empty if the sheet is at the top level of the spreadsheet outline.
restricted	boolean¦null	Indicates whether the sheet has restricted access or functionality

Example

{
  "child_ids": [
    "h65a604b74564afa86b5ba96755845652"
  ],
  "id": "k78a604b74564afa76b5ba96755123456",
  "index": 0,
  "input_mode": false,
  "locked": false,
  "name": "Data Sheet",
  "parent_id": "d10a604b74564afa86b5ba96755845652",
  "restricted": false
}

LegacySpreadsheet

Properties

Name	Type	Description	Restrictions
created	string(date-time)	Date-time (UTC) corresponding to the creation of the spreadsheet
id	string	Unique identifier for the spreadsheet
last_modified	string(date-time)	Date-time (UTC) corresponding to the last modification of the spreadsheet
locked	boolean¦null	Indicates whether the spreadsheet is locked from editing
name	string	Display name for the spreadsheet

Example

{
  "created": "2020-04-30T13:59:49.294Z",
  "id": "567nd179ed984eb5a52aaaba5f83a230",
  "last_modified": "2020-04-30T13:59:52.003Z",
  "locked": false,
  "name": "Test Spreadsheet"
}

RowValues

Properties

Name	Type	Description	Restrictions
anonymous	[DataValue]	String, numeric, or boolean value

Example

[
  "string"
]

Sheet

Details about the sheet, including its ID and name.

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
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"
  }
}