Initiate a file export

Deprecated

This endpoint is deprecated and may be removed in a future release.

This endpoint was deprecated on 2026-02-12.

It is scheduled for sunset on 2027-01-31.

Description#

Export a file or folder for conversion to a Workiva equivalent. This is a long running operation. Responses include a Location header, which indicates where to poll for export results. For more details on long-running job polling, see Operations endpoint. When a Workiva file (tar.gz) export is complete, the status of the Operation will change to completed. The resourceUrl field of the operation will contain the download url of the exported file. To download the file, perform a GET against the resourceUrl with the same authentication credentials and flow as the export request. For more details, see Authentication documentation.

POST /prototype/platform/files/export

Required OAuth Scopes

file:write

Parameters#

Parameter	In	Type	Required	Description
X-Version	header	string	false	Version of the API (2022-01-01)
body	body	PrototypeFileExport	true	The details of the file export

Body parameter example#

{
  "kind": "Workiva",
  "workivaFileExportOptions": {
    "sourceId": "V0ZEYXRhRW50aXR5HkZvbGRlcjowNmUzNjRiNy0wYmFiLTRiOTQtYmM5Yy1lZWRjZTdjMDA4ZTE"
  }
}

Code Samples#

curl

curl -X POST https://api.app.wdesk.com/prototype/platform/files/export \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer {access-token}' \
    -H 'X-Version: 2022-01-01'

httpie

http POST https://api.app.wdesk.com/prototype/platform/files/export \
    X-Version:2022-01-01 \
    Content-Type:application/json \
    Accept:application/json \
    Authorization:"Bearer {access-token}"

wget

wget --method=POST "https://api.app.wdesk.com/prototype/platform/files/export" \
    --output-document -  \ 
    --header 'Content-Type: application/json' \ 
    --header 'Accept: application/json' \ 
    --header 'Authorization: Bearer {access-token}' \
    --header 'X-Version: 2022-01-01'

python

import requests

headers = {
  'X-Version': '2022-01-01',
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.app.wdesk.com/prototype/platform/files/export', headers = headers)

print(r.headers['Location'])