Files

Endpoints to manage files and folders.

File

Details about the file, including its ID, name, kind, and milestone dates.

Properties

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

Enumerated Values

Property	Value
kind	Document
kind	Spreadsheet
kind	Presentation
kind	Folder
kind	Script
kind	SupportingDocument
state	Active
state	Trashed

Example

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

FileCopy

Details about a file copy including the destination container and options

Properties

Name	Type	Description	Restrictions
destinationContainer	string¦null	The unique id of the destination container to copy to. Omit this field to specify the root container. Specifying an empty string is invalid.
options	FileCopyOptions	Additional options for the file copy. If no options are provided, all options default to false.

Example

{
  "destinationContainer": "V0ZEYXRhRW50aXR5HkZvbGRlcjox",
  "options": {
    "destinationName": "New Copied File Name",
    "emailOnComplete": true,
    "includeAttachments": true,
    "includeAutomations": true,
    "includeComments": true,
    "includeCustomFieldValues": true,
    "includeDocumentMarkup": true,
    "includeInputCellValues": true,
    "includeOutlineLabels": true,
    "includeSmartLinkMetadata": true,
    "includeWdataIncomingConnections": true,
    "includeWdataOutgoingConnections": true,
    "includeXBRL": true,
    "includeXBRLDisconnected": true,
    "keepInputModeEnabled": true,
    "removeGRCLinks": true,
    "removeLinks": true,
    "shallowCopy": true
  }
}

FileCopyOptions

Additional options for the file copy. If no options are provided, all options default to false.

Properties

Name	Type	Description	Restrictions
destinationName	string¦null	The name for the copied file. If not specified, the original file name will be used.
emailOnComplete	boolean	Whether or not to email the authorized user when this copy is complete.
includeAttachments	boolean	Whether to preserve attachments for copied content.
includeAutomations	boolean	Whether to preserve automations for copied content.
includeComments	boolean	Whether to preserve comments for copied content.
includeDocumentMarkup	boolean	Whether to preserve document markup for copied content.
includeInputCellValues	boolean	Whether to preserve input cell values for copied content.
includeOutlineLabels	boolean	Whether to preserve outline labels for copied content.
includeSmartLinkMetadata	boolean	Whether to include smart link metadata for copied content.
includeWdataIncomingConnections	boolean	Whether to preserve incoming wdata connections for copied content.
includeWdataOutgoingConnections	boolean	Whether to preserve outgoing wdata connections for copied content.
includeXBRL	boolean	Whether to preserve XBRL for copied content.
includeXBRLDisconnected	boolean	Whether to preserve disconnected XBRL for copied content.
keepInputModeEnabled	boolean	Whether to preserve input mode for copied content.
removeGRCLinks	boolean	Whether to remove any connections to original GRC database, preserving only the textual or value representation of these links. If shallowCopy is true, this option must be false.
removeLinks	boolean	Whether to remove any links from sources that are not part of the operation, preserving only the textual or value representation of these links. If shallowCopy is true, this option must be false.
shallowCopy	boolean	Whether to keep the same source files for your destination links.

Example

{
  "destinationName": "New Copied File Name",
  "emailOnComplete": true,
  "includeAttachments": true,
  "includeAutomations": true,
  "includeComments": true,
  "includeDocumentMarkup": true,
  "includeInputCellValues": true,
  "includeOutlineLabels": true,
  "includeSmartLinkMetadata": true,
  "includeWdataIncomingConnections": true,
  "includeWdataOutgoingConnections": true,
  "includeXBRL": true,
  "includeXBRLDisconnected": true,
  "keepInputModeEnabled": true,
  "removeGRCLinks": true,
  "removeLinks": true,
  "shallowCopy": true
}

FileExportById

Details about a file export including the target type.

Properties

Name	Type	Description	Restrictions
documentExport	DocumentExport¦null	Details about the document export, including its format and options
folderExport	FolderExport¦null	Details about the folder export, including its options
kind	string	Kind (Type) of the file which will be exported.
presentationExport	PresentationExport¦null	Details about the presentation export, including its format and options
spreadsheetExport	SpreadsheetExport¦null	Details about a spreadsheet export.
workivaFileExport	WorkivaFileExport¦null	Details about a Workiva export.

Enumerated Values

Property	Value
kind	Document
kind	Spreadsheet
kind	Presentation
kind	SupportingDocument
kind	Folder
kind	Workiva

Example

{
  "kind": "SupportingDocument"
}

FileImport

Details about a file import including the file name and target kind.

Properties

Name	Type	Description	Restrictions
fileName	string	The name of the file to import. Supported extensions include .XLSX, .CSV, .DOCX, .PPTX, .VSDX, .TAR.GZ unless importing a SupportingDocument which can have any extension.
kind	string	The Workiva file type to upload to. (Document, Spreadsheet, Presentation, Workiva, SupportingDocument)
supportingDocumentImportOptions	SupportingDocumentImportOptions¦null	Additional import options used for Native files. Should only be provided when kind is “Supporting Document”.
workivaFileImportOptions	WorkivaFileImportOptions¦null	Additional import options used for Workiva (.tar.gz) files. Should only be provided when kind is “Workiva”.

Enumerated Values

Property	Value
kind	Document
kind	Spreadsheet
kind	Presentation
kind	Workiva
kind	SupportingDocument

Example

{
  "fileName": "signed_contract.pdf",
  "kind": "SupportingDocument",
  "supportingDocumentImportOptions": {
    "containerId": "V0ZEYXRhRW5zVkNmU2Zi1mZjcE4EzNzk0ZmUwZjk"
  }
}

FileImportResponse

Response to a file import including the URL to upload the file to.

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

FileRestoreOptions

Request body for File restore endpoint

Properties

None

Example

{}

FilesListResult

Returns a JSON object with data and @nextLink properties. data contains a list of File objects, and @nextLink provides the URL to the next set of results. If there are no additional results, @nextLink doesn’t appear. If the request returns no results at all, data contains an empty array.

Properties

Name	Type	Description	Restrictions
@nextLink	string¦null	Pagination link for next set of results
data	[File]	Details about the file, including its ID, name, kind, and milestone dates.	required

Example

{
  "@nextLink": "<opaque_url>",
  "data": [
    {
      "container": "V0ZEYXRhRW50aXR5HkZvbGRlcjpyMTY0NEU1ZkY2OTA1QkM5QTSCMyZCRkRzQzNDO1FGNC",
      "created": {
        "dateTime": "2019-10-30T15:03:27Z",
        "user": {
          "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD"
        }
      },
      "id": "124efa2a142f472ba1ceab34ed18915f",
      "kind": "Document",
      "modified": {
        "dateTime": "2019-10-30T15:03:27Z",
        "user": {
          "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD"
        }
      },
      "name": "Year-end review",
      "state": "Active",
      "template": false,
      "type": "10-K"
    }
  ]
}

FileTrashOptions

Request body for File trash endpoint

Properties

None

Example

{}

FolderExport

Details about the folder export, including its options

Properties

Name	Type	Description	Restrictions
emailOnComplete	boolean	Whether or not to email the authorized user when this upload is complete.
includeAttachments	boolean	Whether to preserve attachments for exported content.
includeComments	boolean	Whether to preserve comments for exported content.
includeCustomFieldValues	boolean	Whether to preserve custom field values for exported content.
includeDocumentMarkup	boolean	Whether to preserve document markup for exported content.
includeInputCellValues	boolean	Whether to preserve input cell values for exported content.
includeOutlineLabels	boolean	Whether to preserve outline labels for exported content.
includeSmartLinkMetadata	boolean	Whether to include smart link metadata for exported content.
includeWdataIncomingConnections	boolean	Whether to preserve incoming wdata connections for exported content.
includeWdataOutgoingConnections	boolean	Whether to preserve outgoing wdata connections for exported content.
includeXBRL	boolean	Whether to preserve XBRL for exported content.
includeXBRLDisconnected	boolean	Whether to preserve disconnected XBRL for exported content.
keepInputModeEnabled	boolean	Whether to preserve input mode for exported content.
removeGRCLinks	boolean	Whether to remove any connections to original GRC database, preserving only the textual or value representation of these links.
removeLinks	boolean	Whether to remove any links from sources that are not part of the operation, preserving only the textual or value representation of these links.

Example

{
  "emailOnComplete": true,
  "includeAttachments": true,
  "includeComments": true,
  "includeCustomFieldValues": true,
  "includeDocumentMarkup": true,
  "includeInputCellValues": true,
  "includeOutlineLabels": true,
  "includeSmartLinkMetadata": true,
  "includeWdataIncomingConnections": true,
  "includeWdataOutgoingConnections": true,
  "includeXBRL": true,
  "includeXBRLDisconnected": true,
  "keepInputModeEnabled": true,
  "removeGRCLinks": true,
  "removeLinks": true
}

WorkivaFileExport

Details about a Workiva export.

Properties

Name	Type	Description	Restrictions
workivaFileExportOptions	WorkivaFileExportByIdOptions¦null	Additional export options used for Workiva (.tar.gz) files. Should only be provided when type is “Workiva”.

Example

{
  "workivaFileExportOptions": {
    "emailOnComplete": true,
    "includeXBRL": true
  }
}

WorkivaFileExportByIdOptions

Additional export options used for Workiva (.tar.gz) files. Should only be provided when type is “Workiva”.

Properties

Name	Type	Description	Restrictions
emailOnComplete	boolean	Whether or not to email the authorized user when this upload is complete.
includeAttachments	boolean	Whether to preserve attachments for exported content.
includeComments	boolean	Whether to preserve comments for exported content.
includeCustomFieldValues	boolean	Whether to preserve custom field values for exported content.
includeDocumentMarkup	boolean	Whether to preserve document markup for exported content.
includeInputCellValues	boolean	Whether to preserve input cell values for exported content.
includeOutlineLabels	boolean	Whether to preserve outline labels for exported content.
includeSmartLinkMetadata	boolean	Whether to include smart link metadata for exported content.
includeWdataIncomingConnections	boolean	Whether to preserve incoming wdata connections for exported content.
includeWdataOutgoingConnections	boolean	Whether to preserve outgoing wdata connections for exported content.
includeXBRL	boolean	Whether to preserve XBRL for exported content.
includeXBRLDisconnected	boolean	Whether to preserve disconnected XBRL for exported content.
keepInputModeEnabled	boolean	Whether to preserve input mode for exported content.
removeGRCLinks	boolean	Whether to remove any connections to original GRC database, preserving only the textual or value representation of these links.
removeLinks	boolean	Whether to remove any links from sources that are not part of the operation, preserving only the textual or value representation of these links.

Example

{
  "emailOnComplete": true,
  "includeAttachments": true,
  "includeComments": true,
  "includeCustomFieldValues": true,
  "includeDocumentMarkup": true,
  "includeInputCellValues": true,
  "includeOutlineLabels": true,
  "includeSmartLinkMetadata": true,
  "includeWdataIncomingConnections": true,
  "includeWdataOutgoingConnections": true,
  "includeXBRL": true,
  "includeXBRLDisconnected": true,
  "keepInputModeEnabled": true,
  "removeGRCLinks": true,
  "removeLinks": true
}

WorkivaFileImportOptions

Additional import options used for Workiva (.tar.gz) files. Should only be provided when kind is “Workiva”.

Properties

Name	Type	Description	Restrictions
createNewResultContainer	boolean	Whether to create new result container for imported content.
destinationContainer	string	The ID of the folder in which to place the newly imported files. Set this to “” to import to the root folder.
emailOnComplete	boolean	Whether or not to email the authorized user when this upload is complete.
includeAttachments	boolean	Whether to preserve attachments for imported content.
includeComments	boolean	Whether to preserve comments for imported content.
includeCustomFieldValues	boolean	Whether to preserve custom field values for imported content.
includeDocumentMarkup	boolean	Whether to preserve document markup for imported content.
includeInputCellValues	boolean	Whether to preserve input cell values for imported content.
includeOutlineLabels	boolean	Whether to preserve outline labels for imported content.
includeSmartLinkMetadata	boolean	Whether to include smart link metadata for imported content.
includeWdataIncomingConnections	boolean	Whether to preserve incoming wdata connections for imported content.
includeWdataOutgoingConnections	boolean	Whether to preserve outgoing wdata connections for imported content.
includeXBRL	boolean	Whether to preserve XBRL for imported content.
includeXBRLDisconnected	boolean	Whether to preserve disconnected XBRL for imported content.
keepInputModeEnabled	boolean	Whether to preserve input mode for imported content.
newResultContainerName	string	What name to provide to the new result container for imported content.

Example

{
  "createNewResultContainer": true,
  "destinationContainer": "V0ZEYXRhRW5zVkNmU2Zi1mZjcE4EzNzk0ZmUwZjk",
  "emailOnComplete": true,
  "includeAttachments": true,
  "includeComments": true,
  "includeCustomFieldValues": true,
  "includeDocumentMarkup": true,
  "includeInputCellValues": true,
  "includeOutlineLabels": true,
  "includeSmartLinkMetadata": true,
  "includeWdataIncomingConnections": true,
  "includeWdataOutgoingConnections": true,
  "includeXBRL": true,
  "includeXBRLDisconnected": true,
  "keepInputModeEnabled": true,
  "newResultContainerName": "Q4 Earnings 2024"
}

SupportingDocumentImportOptions

Additional import options used for Native files. Should only be provided when kind is “Supporting Document”.

Properties

Name	Type	Description	Restrictions
containerId	string	The ID of the folder in which to place the newly imported files. Set this to the empty string ("") to import to the root folder.

Example

{
  "containerId": "V0ZEYXRhRW5zVkNmU2Zi1mZjcE4EzNzk0ZmUwZjk"
}