Using the API Collection: Import a file to Workiva

Introduction

This article walks you through the process of importing a file into Workiva using the Workiva API collections.

You must have successfully completed all steps from the Importing Workiva API Collections into Postman guide.

Open your postman workspace and make sure to choose the correct environment.
Expand the oauth2 folder, followed by the oauth2 folder and open the Retrieve a token request.
Click Send to run this request and generate your authentication token. This token is automatically stored in the {{access_token}} environment variable and will be auto-populated in all endpoint requests you run.

Note: The token will expire after 600 seconds (10 minutes) and you then need to repeat this step to generate a new one.

Expand the Workiva API collection, followed by the Files and then the Import folders.
Open the Initiate a file import request.
Edit the request body the the following details.
- FileName: The name of the file to import. Supported extensions include (.XLSX, .CSV, .DOCX, .PPTX, .VSDX, .TAR.GZ)
- Kind: The Workiva file type to upload to (Document, Spreadsheet, Presentation).
Send the POST request.
Copy the UploadUrl that is returned from the Body.
Create a new PUT request and enter the UploadURL from the previous request.
Select the body tab and Pick the binary option.
From the Select file dropdown, select the file you want to upload from your local machine.
Make sure the file type matches the type specified in the previous request. For example, if kind = Document, the file you upload should be a .docx file.
Click send
You should see a 200 response
Next check Workiva and the file should be there in this example it is in a Workiva document format.