Skip to main content
lgaertner
Level 9
Jun 27, 2023 3:24 PM UTC
Solved

Download document using the API

Hello,

 

I would like to download the binary of a document via the API to get a blob object. 

Is this somehow possible? I cannot find the corresponding information using the API-explorer.

I know, that I can retrieve the field downloadURL, but using this requires to be logged in to Workfront.

 

Thanks in advance.

 

Regards

Lars

This post is no longer active and is closed to new replies. Need help? Start a new post to ask your question.
ChrisStephens
ChrisStephensAccepted solution
Community Advisor
Jun 27, 2023 4:55 PM UTC

That's what you have to do. You have to get the download url, and then download it with that url, and both of those require an API key or a session ID.

12 replies

ChrisStephens
Community Advisor
ChrisStephensCommunity AdvisorAccepted solution
Community Advisor
Jun 27, 2023 4:55 PM UTC

That's what you have to do. You have to get the download url, and then download it with that url, and both of those require an API key or a session ID.

Translate
Level 3
Mar 13, 2024 3:36 PM UTC

How can I get the file extension in the endpoint -  /attask/api/v17.0/document/search?projectID=xxxxxxxxx&fields=folders,downloadURL . I tried adding fileType, but I'm getting below message.

 

"field 'fileType' is not available"
Could you please help?
Translate
ChrisStephens
Community Advisor
Community Advisor
Mar 13, 2024 3:39 PM UTC

The file Type parameter is on the version object, so if you include currentVersion:ext, that should give it to you.

Translate
Level 1
Apr 2, 2024 9:28 PM UTC

I am also having a problem downloading a document. I am providing an apiKey (I've tried in both $body and $header) in a CURL command through Powershell.

The $url variable contains something like this:
https://<mycompany>.my.workfront.com/internal/document/download?ID=abc123456def123456
$downloadResponse = Curl -Uri $url -Header $header -Body $body -OutFile $downloadPath

All I am getting back is a 4k file, starting with this:

<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
 
<body onload="document.forms[0].submit()">
<noscript>
<p>
<strong>Note:</strong> Since your browser does not support JavaScript,
you must press the Continue button once to proceed.
</p>
</noscript>

 

Translate
Jul 18, 2024 11:41 PM UTC

Having the exact same error. If i open the provided URL in my browser it downloads just fine; but trying to do it programmatically produces an error.

 

Were you able to solve the issue?

Translate