How to download file pdf from ihub server by REST API

Tráº§n Quá»‘c Viá»‡t · July 25, 2016

I use ihub 16 and i try to download file pdf by REST API use method /files/{fileId}/download , but i can't view file obtained . Please help me !

Clement Wong · July 26, 2016

What version of the REST API?
 
For iHub 16, version 2 (preferred) is located at:
<pre class="_prettyXprint">
http://your-ihub-server:8000/api/v2/ihubrestdocs/</pre>
Do you want the PDF from the .RPTDOCUMENT?
<pre class="_prettyXprint _lang-">
http://your-ihub-server:8000/api/v2/visuals/{fileID}/pdf
</pre>
But you referenced /download so there is an existing PDF on the iHub volume that you want to download?
<pre class="_prettyXprint _lang-">
http://your-ihub-server:8000/api/v2/files/{fileID}/download?base64=false
</pre>
And putting this together in an example page...
<pre class="_prettyXprint _lang-">
<!DOCTYPE html>
<html>
<body>

<button onclick="saveContent();">PDF</button>

<script>
function saveContent(fileContents, fileName)
{
var link = document.createElement('a');

downloadFile('http://your-ihub-server:8000/api/v2/files/131100000100/download?base64=false', function(blob) {
var url = URL.createObjectURL(blob);
link.href = url;
link.download = "Client Portfolio.PDF";
link.click();
});
}

function downloadFile(url, success) {
var xhr = new XMLHttpRequest();
xhr.open('GET', url, true);
xhr.setRequestHeader("AuthToken", "your-AuthToken-here");
xhr.responseType = "blob";
xhr.onreadystatechange = function() {
if (xhr.readyState == 4) {
if (success) success(xhr.response);
}
};
xhr.send(null);
}

</script>
</body>
</html>
</pre>
It looks like the documentation is not correct where you would set base64=true for PDF, but you'll need to set it to false instead. I'll file a ticket to have that corrected.

Tráº§n Quá»‘c Viá»‡t · July 31, 2016

actuate now i cannot download file from Rest Api. how i can fix it. when i fill feilds and click 'Try it out' have a noice from Internet Download Manager that 'cannot download this file '

Clement Wong · August 1, 2016

Through the REST API v2 Swagger interface, you'll need to set base64 to false, and of course, the File ID. Then, click on 'Try it out'.
 
If successful, in the Response Body, there will be a link in green.
"download?base64=false"
 
Right click on that link, and choose "Save link as..."
 
You'll see a random file name so give the download a file name and a .PDF extension.

Tráº§n Quá»‘c Viá»‡t · August 1, 2016

<blockquote class="ipsBlockquote" data-author="Clement Wong" data-cid="144778" data-time="1470091350">
<div>
Through the REST API v2 Swagger interface, you'll need to set base64 to false, and of course, the File ID. Then, click on 'Try it out'.
 
If successful, in the Response Body, there will be a link in green.
"download?base64=false"
 
Right click on that link, and choose "Save link as..."
 
You'll see a random file name so give the download a file name and a .PDF extension.
</div>
</blockquote>
I alway set base64=false . but if i download file from other computer in LAN (ihub 16 is setup on my server and i download file from my computer) will have notice that "cannot download this file" by IDM with response code = 204 on rest api interface. and if i download file directy from my server, brower will download that file but i can not read it, its name like this :
<blockquote class="ipsBlockquote">
 
application-octet-stream-download-base64=false-blob-http%3A--localhost%3A8000-703e0b1c-d820-4ea5-aeeb-f59cdf822617
</blockquote>

Clement Wong · August 3, 2016

The REST API UI for downloading in might not be the real-world use case. I'm not sure what IDM you are using, but what if you tried a different browser, or a stock browser without any download manager.
 
The behavior that you see, when you download using the server's browser is expected behavior no matter where you are. As I mentioned previously, that tou'll see a random file name so give the download a file name and a .PDF extension. 

Please use the example HTML code that I provided that uses the HTML5 download attribute to save a file with a specific file name.

Tráº§n Quá»‘c Viá»‡t · August 4, 2016

<blockquote class="ipsBlockquote" data-author="Clement Wong" data-cid="144803" data-time="1470246106">
<div>
The REST API UI for downloading in might not be the real-world use case. I'm not sure what IDM you are using, but what if you tried a different browser, or a stock browser without any download manager.
 
The behavior that you see, when you download using the server's browser is expected behavior no matter where you are. As I mentioned previously, that tou'll see a random file name so give the download a file name and a .PDF extension. 

Please use the example HTML code that I provided that uses the HTML5 download attribute to save a file with a specific file name.
</div>
</blockquote>
Thank you for answer my topic, but i still can't solve this probem. what happened with me show in below video, can you help me !!
<a data-ipb='nomediaparse' href='

https://youtu.be/Y4vR4NuujBs'>https://youtu.be/Y4vR4NuujBs</a>
 
Response Headers
<pre class="_prettyXprint _lang-js">
{
"server": "Apache-Coyote/1.1",
"access-control-allow-origin": "*",
"access-control-allow-methods": "POST, OPTIONS, GET, PUT, DELETE, PATCH",
"access-control-allow-headers": "Origin, X-Requested-With, Content-Type, Accept, AuthToken, Locale, TargetVolume",
"access-control-expose-headers": "Location",
"content-disposition": "attachment; filename=sdf.PDF",
"content-description": "File Transfer",
"accept": "application/octet-stream",
"vary": "Accept-Encoding",
"content-encoding": "gzip",
"content-type": "application/octet-stream",
"transfer-encoding": "chunked",
"date": "Fri, 05 Aug 2016 02:42:00 GMT"
}
</pre>

Clement Wong · August 8, 2016

As I mentioned in the previous posts, when you using the REST API v2 UI, the download in the response body needs on extra manual step. I did not see that in the video.
 
So instead of (left) clicking on the link you did @ 1:20, please right click on the link.
 
Then choose the option "Save link as..." (Firefox), or "Save as..." (Chrome).
 
Name the file, and give the file a .PDF extension name.
 
 
If you're not using the REST API v2 UI, then you'll need to use the HTML5 download attribute.

Tráº§n Quá»‘c Viá»‡t · August 11, 2016

<blockquote class="ipsBlockquote" data-author="Clement Wong" data-cid="144857" data-time="1470673651">
<div>
As I mentioned in the previous posts, when you using the REST API v2 UI, the download in the response body needs on extra manual step. I did not see that in the video.
 
So instead of (left) clicking on the link you did @ 1:20, please right click on the link.
 
Then choose the option "Save link as..." (Firefox), or "Save as..." (Chrome).
 
Name the file, and give the file a .PDF extension name.
 
 
If you're not using the REST API v2 UI, then you'll need to use the HTML5 download attribute.
</div>
</blockquote>
I did as everything you say at above, but it don't work (can't read file downloaded). And i try to use again your code is provided at #2 and recognize that it only work when i use server on my computer but don't work when i use server at my LAN (outside my computer). It can't get xhr.response (null). Thank for help

Clement Wong · August 11, 2016

One thing that comes to mind when you say that it works on the iHub server, but not on the LAN is due to Cross-Origin Resource Sharing. You said that you're getting a null for xhr.response, which could occur because of the limit by the same origin policy.
 
To provide you with better response time and further assistance, I recommend that you contact your local OpenText Analytics support center. Here is a list for reference (<a data-ipb='nomediaparse' href='http://www.actuate.com/resources/support/global-support-centers/'>http://www.actuate.com/resources/support/global-support-centers/</a>).

Sam Bachman · December 9, 2021

var xhr = new XMLHttpRequest();
xhr.open('GET', 'https://abc.com:8001/api/v2/files/'+id+'/download?base64=false', true);
xhr.setRequestHeader("AuthToken", localStorage.getItem('actuateRestAuthId'));
xhr.responseType = "blob";
xhr.onreadystatechange = function() {
    if (xhr.readyState == 4) {
        var link = document.createElement('a'), url = URL.createObjectURL(xhr.response);
        link.href = url;
        link.download = "Client Portfolio.jpg";
        link.click();
    }
};
xhr.send(null);

How to download file pdf from ihub server by REST API

Comments

Categories