Files

Endpoints to manage files and folders.

File

Properties

Name	Type	Description	Restrictions
container	string	The unique identifier of the container that houses the file, such as a folder. If empty, the root folder is the container.
created	Action	When the action was performed, and details about the user who did it	read-only
id	string	The unique identifier of the file	read-only
kind	string	Kind of the file
modified	Action	When the action was performed, and details about the user who did it	read-only
name	string	Name of the file
template	boolean		read-only
type	string	Type of the file	read-only

Example

{
  "container": "V0ZEYXRhRW50aXR5HkZvbGRlcjpyMTY0NEU1ZkY2OTA1QkM5QTSCMyZCRkRzQzNDO1FGNC",
  "created": {
    "dateTime": "2019-10-30T15:03:27Z",
    "user": {
      "displayName": "string",
      "email": "string",
      "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD"
    }
  },
  "id": "124efa2a142f472ba1ceab34ed18915f",
  "kind": "Document",
  "modified": {
    "dateTime": "2019-10-30T15:03:27Z",
    "user": {
      "displayName": "string",
      "email": "string",
      "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD"
    }
  },
  "name": "Year-end review",
  "template": false,
  "type": "10-K"
}

FileImport

Properties

Name	Type	Description	Restrictions
fileName	string	The name of the file to upload. Supported extensions include .XLSX, .CSV, .DOCX, .PPTX, .VSDX.
kind	string	The Workiva file type to upload to. (Document, Spreadsheet, Presentation)

Enumerated Values

Property	Value
kind	`Document`
kind	`Spreadsheet`
kind	`Presentation`

Example

{
  "fileName": "quarterly_report.docx",
  "kind": "Document"
}

FileImportResponse

Properties

Name	Type	Description	Restrictions
uploadUrl	string	The signed URL used to upload the file. Make a PUT request to this URL whose body is the contents of the file to upload.

Example

{
  "uploadUrl": "{opaqueUrl}"
}