Initiate a file import

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#

Import a file for conversion to a Workiva equivalent. This is a long running operation. Response includes an uploadUrl and a header Location. The uploadUrl indicates where to upload the file for import. To upload the file, perform a PUT request against the uploadUrl with the same authentication credentials and flow as the import request. For more details, see Authentication documentation. The Location header indicates where to poll for import file results. For more details on long-running job polling, see Operations endpoint. When a Workiva file (tar.gz) import is complete, the status of the Operation will change to completed. The resourceUrl field of the Operation will contain a link to the Import file results endpoint. This resourceUrl field allows to fetch the details about the file which is successfully imported.

POST /prototype/platform/files/import

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	PrototypeFileImport	true	The details of the file import

Body parameter example#

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

Code Samples#

curl

curl -X POST https://api.app.wdesk.com/prototype/platform/files/import \
    -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/import \
    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/import" \
    --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/import', headers = headers)

print(r.headers['Location'])

Returns#