Rest API - How Get File From Attachment

[Rezky]

Hi Everyone,
Is there a way to retrieve files via Rest API ?

I haven't found any documentation regarding attachments in the Rest API.

If the data provided is binary data based, how can I convert it into a PDF file either for reading or for downloading.

Thank you for your help.

Regards,
Rezky

[Diego Ruiz]

Hi Rezky,

There are three ways to retrieve files with the REST API, depending on which file you want to get.

1 - Get attachments from a record

• .../api/v1/models/{tablename}/{id}/attachments -> get all attachments from the record id of the given table
• .../api/v1/models/{tablename}/{id}/attachments/zip -> get all attachments from the record id of the given table in a zip file
• .../api/v1/models/{tablename}/{id}/attachments/{filename} -> get the content of attachment with the filename from the record id of the given table

2 - Get the print format from the model's record ID. It returns the file that you get when you click print on the WebUI

• .../api/v1/models/{tablename}/{recordId}/print

3 - Get a file content

• .../api/v1/files/{fileName}?length={processFileLength}&nodeId={processNodeId}

Regarding the conversion of the result to PDF. It depends on the language you're using to request the file. You can google How to convert Base64 to File in ...

Best regards,

Diego

[Rezky]

Hi Diego,
I really appreciate your help.

Referring to your solution, I would like to explain what steps I have taken below, in order to explain the problem I am facing.

(Note : I am using Rest API with Version 0.1.0.202211181521)
- .../api/v1/models/{tablename}/{id}/attachments ->  The information provided is the file name and type, there is no binary data that I can convert into a file.

-  .../api/v1/models/{tablename}/{id}/attachments/{filename} -> Not Acceptable, Are there any steps or requirements that I missed?

Then I looked for another way by accessing the attachment table. 
-  .../api/v1/models/AD_Attachment -> I got the record, and I found binary data.

However, when I tried to decode the binary data, I only got the file directory path in XML format like this.

<?xml version="1.0" encoding="UTF-8"?><attachments><entry file="%ATTACHMENT_FOLDER%1000003\0\259\1004913\Export_C_InvoiceLine.pdf" name="Export_C_InvoiceLine.pdf"/></attachments>

What makes me confused is how to obtain a physical file that I can download or view, whether the data obtained is in the form of Binary Data which can be decoded as I once tried for an Image file on a form, via the Rest API service.
Thank You,

Regards,

Rezky

[Carlos Antonio Ruiz Gomez]

Hi Rezky,

I just did tests with local master (release-11) and demo.globalqss.com (release-10) and both worked fine.

You can try in your postman like:

https://demo.globalqss.com:443/api/v1/models/c_order/1000025/attachments

https://demo.globalqss.com:443/api/v1/models/c_order/1000025/attachments/zip

https://demo.globalqss.com:443/api/v1/models/c_order/1000025/attachments/calibration_iriscananywhere.pdf

It works perfect from postman.

Maybe your headers are different?  Check against the postman examples.

Regards,

Carlos Ruiz

On 19/9/23 a las 6:14, Rezky wrote:

Hi Diego,
I really appreciate your help.

Referring to your solution, I would like to explain what steps I have taken below, in order to explain the problem I am facing.

(Note : I am using Rest API with Version 0.1.0.202211181521)
- .../api/v1/models/{tablename}/{id}/attachments ->  The information provided is the file name and type, there is no binary data that I can convert into a file.

-  .../api/v1/models/{tablename}/{id}/attachments/{filename} -> Not Acceptable, Are there any steps or requirements that I missed?

Then I looked for another way by accessing the attachment table. 
-  .../api/v1/models/AD_Attachment -> I got the record, and I found binary data.

[Rezky]

I am using File System method as Storage Provider, meanwhile in Garden Admin is using Database Method.
So in AD_Attachment - binary column, instead of actual binary data, it keeps path info of the file in xml format like I mention before:

<?xml version="1.0" encoding="UTF-8"?><attachments><entry file="%ATTACHMENT_FOLDER%1000003\0\259\1004913\Export_C_InvoiceLine.pdf" name="Export_C_InvoiceLine.pdf"/></attachments>

So furher question is the app method for attachment also support for File System method as storage provider?

[Carlos Antonio Ruiz Gomez]

Yes, I noticed that and tested with both scenarios, DB and FileSystem, both worked fine.

Regards,

Carlos Ruiz

El 19/9/23 a las 17:47, Rezky escribió:

[Rezky]

Hi Carlos,

Sorry for ask again, for the latest Rest API plugin jar, is it required to use JVM v17? I'm still using JVM v11.

Thank You.

Regards,

Rezky

[Carlos Antonio Ruiz Gomez]

The repository has two branches,

release-10 must be compiled with java 11

master must be compiled with java 17  (I think it probably must compile with java 11 too, but is better to be in sync with the iDempiere core)

Regards,

Carlos Ruiz

On 20/9/23 at 15:34, Rezky wrote:

Hi Carlos,

Sorry for ask again, for the latest Rest API plugin jar, is it required to use JVM v17? I'm still using JVM v11.

[ROGER ROMERO]

Good afternoon, dear Carlos Ruiz. A pleasure to greet. 

I would like to know if the plugin: com.trekglobal.idempiere.rest.api can be used with the release-9 version of Idempiere?

Is there a tutorial on how to implement it? 

I ask this because in the plugin repository, there is no release-9 branch.

Regards,

Roger Romero

[Carlos Antonio Ruiz Gomez]

It won't work straight, you can try to fix the broken parts and make it compatible.

Am 17.11.23 um 21:36 schrieb ROGER ROMERO:

[ROGER ROMERO]

Thank you very much for the response, dear Carlos.

--
You received this message because you are subscribed to the Google Groups "iDempiere" group.
To unsubscribe from this group and stop receiving emails from it, send an email to idempiere+...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/idempiere/53eb35d4-cab2-4859-aa6d-37bdc89cfba2%40gmail.com.

[Simon Josue Puyosa Raffoul]

Hello Carlos,

I'm encountering an issue with the API endpoint /api/v1/models/AD_Attachment. Currently, when attempting to use POST or PUT methods to upload a ZIP file (encoded in base64 or as bytes), the binaryData field ends up as null.

Could you assist me in finding a solution? Ideally, I'm looking for a method to successfully send a ZIP containing all attachments either through /api/v1/models/AD_Attachment or perhaps /api/v1/models/{tableName}/{id}/attachments/zip.

Thank you for your help in advance.

[Carlos Antonio Ruiz Gomez]

Hi Simon, can you please do a test against demo.globalqss.com and share here the postman (or body) for your failing case?

Regards,

Carlos Ruiz

[Simon Josue Puyosa Raffoul]

I actually managed to post the attachment while taking screenshots. However, I'm still facing issues when trying to edit an already created attachment. Initially, I attempted to edit and send it using models/ad_attachments, but in the post, the binaryData in base64 converts to null. I think this might be a bug

When I attempted a PUT request, it resulted in a 500 error due to issues with editing binaryData. This is also a problem

 

Another method I tried was using models/table_name/id/attachments/zip. This approach allowed me to successfully post the attachment.

 

Unfortunately, when attempting to edit using this method, I encountered a 405 error indicating that the method is not allowed :(

While I can manage with the workaround of deleting and reposting to edit an attachment, it involves making two requests for what should ideally be a single action.

[Carlos Antonio Ruiz Gomez]

Can you share here a postman of the failing case against demo.globalqss.com?

On 7/19/24 16:34, Simon Josue Puyosa Raffoul wrote:

I actually managed to post the attachment while taking screenshots. However, I'm still facing issues when trying to edit an already created attachment. Initially, I attempted to edit and send it using models/ad_attachments, but in the post, the binaryData in base64 converts to null. I think this might be a bug

When I attempted a PUT request, it resulted in a 500 error due to issues with editing binaryData. This is also a problem

 

Another method I tried was using models/table_name/id/attachments/zip. This approach allowed me to successfully post the attachment.

 

Unfortunately, when attempting to edit using this method, I encountered a 405 error indicating that the method is not allowed :(

[Simon Josue Puyosa Raffoul]

Sure

1. This is the bug where posting to ad_attachment makes binaryData null. You can see it because it does not return a binaryData value:


2. This is the bug where ad_attachment does not permit you to modify binaryData:


Honestly, I'm okay with working only with url/api/v1/models/{table_name}/{id}/attachments/zip for posting (I did that to demonstrate the next bug). The problem here is that I cannot edit the attachment by updating it with new data.

3. This is the bug where attachments/zip or attachments does not let me modify the data value.