topic RE: Web API Services - To upload a file using multipart form data in Product Forum

Web API Services - To upload a file using multipart form data

AbhilashM — Wed, 08 Jun 2022 11:13:00 GMT

Hi Dear Community,

I have tried using form data module in postman to successfully upload the file to the target application. However, in the blue prism Web API services section - I am not able to successfully configure the API for upload.

The API documentation consumes the parameters as query params and use form-data to accept the file with multipart/form data and boundary established. Can you please guide me on how to go about setting this up in Blue Prism?

Thank you
Abhilash M
RPA Developer
Lowe's Companies.

------------------------------
Abhilash M
------------------------------

RE: Web API Services - To upload a file using multipart form data

shashank.kumar280 — Wed, 08 Jun 2022 11:52:00 GMT

Hi Abhilash,

If you can post a screenshot of your postman configuration that would be helpful. The Utility - HTTP has a specific action to deal with multipart. Have you tried that already?

For using the WebAPI you will have to set the params in the Body Template.

There is a sample request in this thread https://community.blueprism.com/communities/community-home/digestviewer/viewthread?GroupId=145&MessageKey=52119c58-2f30-465b-b65e-61862a3d75fe&CommunityKey=3743dbaa-6766-4a4d-b7ed-9a98b6b1dd01&tab=digestviewer

------------------------------
Shashank Kumar
DX Integrations Partner Consultant
Blue Prism
Singapore
+6581326707
------------------------------

RE: Web API Services - To upload a file using multipart form data

AbhilashM — Wed, 08 Jun 2022 12:46:00 GMT

Hi Shashank,

Thank you for your response.

I have attached the snapshot. The URL is composed of several query params.
The body is of type form-data which has 3 parameters and the parameter file is of type "file"

This setup works just fine. I need to figure out a way to apply similar functionality in BluePrism.

I did go through the thread you shared regarding params in Body Template- I have trouble with the fileValue param at the end.
Currently the error Blue Prism throws with the setup Bimal suggested in the screenshot is:-

Internal : Unexpected error Error during Web API HTTP Request
HTTP Status Code: 404
HTTP Response Content: {"timestamp":"2022-06-08 12:31:15","status":404,"error":"Not Found","message":"No message available","path":"/<<Request URL>>"}

Also I have not tried the HTTP Utility yet and if you could share more details on that which will be helpful. I only see a HTTP VBO but not the extended in the current setup. Do let me know if the standard one works just fine.

Thank you
Abhilash M

------------------------------
Abhilash M
------------------------------

RE: Web API Services - To upload a file using multipart form data

shashank.kumar280 — Wed, 08 Jun 2022 12:49:00 GMT

Hi Abhilash,

You can get the latest Utility - HTTP from https://digitalexchange.blueprism.com/dx/entry/3439/solution/utility---http

Using the utility is quicker than building the body template yourself.

------------------------------
Shashank Kumar
DX Integrations Partner Consultant
Blue Prism
Singapore
+6581326707
------------------------------

RE: Web API Services - To upload a file using multipart form data

AbhilashM — Wed, 08 Jun 2022 13:01:00 GMT

Thank you Shashank, I will certainly give this a go and keep the community updated.

Thank you
Abhilash M

------------------------------
Abhilash M
------------------------------

RE: Web API Services - To upload a file using multipart form data

AbhilashM — Wed, 08 Jun 2022 16:04:00 GMT

Hi Dear Community,

Would there be any community user who can help me with the file meta data and field meta data collection examples used in the HTTP-Utility VBO.

I have used the certain sample inputs to the two collections but seems to be missing something important.

Current error : The remote server returned an error: (503) Server Unavailable.

Thank you
Abhilash M

------------------------------
Abhilash M
------------------------------

RE: Web API Services - To upload a file using multipart form data

PabloSarabia — Wed, 08 Jun 2022 17:54:00 GMT

Hi @AbhilashM

You are getting the error from the service. So you are calling it correctly.

The 5xx errors, are errors from the server part.

Which action are you calling it?

See you in the Community, bye 🙂

------------------------------
Pablo Sarabia
Solution Manager & Architect
Altamira Assets Management
Madrid
------------------------------

RE: Web API Services - To upload a file using multipart form data

shashank.kumar280 — Thu, 09 Jun 2022 05:20:00 GMT

Hi Abhilash,

The field metadata should contain all the key/value pairs other than the binary file.

The binary file related metadata goes in the file metadata collection.

------------------------------
Shashank Kumar
DX Integrations Partner Consultant
Blue Prism
Singapore
+6581326707
------------------------------

RE: Web API Services - To upload a file using multipart form data

AbhilashM — Mon, 13 Jun 2022 12:57:00 GMT

Updates I have so far -

I have used the file meta data collection to include the key/value pair values used in postman under the form-data setup
I have used the file meta data collection to only pass the file path as the other params (filename, fieldname and content type are optional)
Could you please help me with the header content-type in this scenario?

Thank you
Abhilash M

------------------------------
Abhilash M
------------------------------

RE: Web API Services - To upload a file using multipart form data

shashank.kumar280 — Mon, 13 Jun 2022 13:01:00 GMT

The metadata collection for File can include fieldname as "file" and content type as "application/octet-stream".

------------------------------
Shashank Kumar
DX Integrations Partner Consultant
Blue Prism
Singapore
+6581326707
------------------------------

RE: Web API Services - To upload a file using multipart form data

AbhilashM — Mon, 13 Jun 2022 13:49:00 GMT

Hi Dear Community,

The API is now successfully uploading the file to the target application. Thank you Shashank Kumar and all members in the thread for helping me out on the issue.

Details for your reference:

VBO:- Utility - HTTP 6.10.3
Action - HTTP Request Multipart
Parameters populated in said Action are as below
Address URL:- The complete URL for the API with query params
Headers:- A collection containing required headers for the request
FileMetadata:- File based form-data body parameters(key value pairs) as implemented in postman (Donot use file binary input here as suggessted earlier)
FieldMetadata:-File meta data

File meta data contains:-

FileName : Left blank since optional
FieldName : file
ContentType : application/octet-stream
FilePath : Absolute file path

Thank you
Abhilash M
Lowe's Companies

------------------------------
Abhilash M
------------------------------

RE: Web API Services - To upload a file using multipart form data

KiranSingh1 — Fri, 21 Oct 2022 13:04:00 GMT

Hi @AbhilashM

I am implementing a similar case in Blue prism using your solution reference. But, I am getting 500 status code.
My File meta data contains :

FileName : Left blank since optional
FieldName : file
ContentType : application/octet-stream
FilePath : Absolute file path

Could you please let me know what I need to set in the FieldMetadata collection ? Your solution screenshot will be helpful for me .
Also, I do not need to set Content-Type as "multipart/form-data" explicity. Is my understanding right?

Many Thanks!

------------------------------
Kiran Singh
------------------------------

RE: Web API Services - To upload a file using multipart form data

sushmaAchar — Wed, 26 Oct 2022 18:11:00 GMT

Hi @shashank.kumar280 ,

I am facing similar issue while sending xlsx file with the HTTP Request Multipart action in the HTTP-Utility VBO.

The file metadata has:

FieldName : file
ContentType: multipart/form-data
FilePath: Absolute path of the xlsx file

What should be given in the FieldMetadata? It is having Name and Value as fields? Should I covert the xlsx file into binary file?

------------------------------
sushma Achar
------------------------------

RE: Web API Services - To upload a file using multipart form data

neiljor — Thu, 27 Oct 2022 12:58:00 GMT

I struggled with this for a while too, so hopefully this will help.

In my case, I am posting a csv file. I set the filename and absolute filepath in the filesCollection. I do not set the content type or field name. I do not use the fieldmetadata collection at all. I don't think there is any need to set the content type in the filesCollection, though to post excel it may need to be application/vnd.ms-excel.

Regards
Neil.

------------------------------
Neil Jordan
------------------------------

RE: Web API Services - To upload a file using multipart form data

KiranSingh1 — Mon, 07 Nov 2022 15:47:00 GMT

Hello @neiljor,

Could you please share the screenshots of your implementation ?
That might be useful, as I am still stuck with the problem.

Thanks in Advance!

Kind Regards,
Kiran Singh

------------------------------
Kiran Singh
------------------------------

RE: Web API Services - To upload a file using multipart form data

shashank.kumar280 — Mon, 07 Nov 2022 17:11:00 GMT

The FileMetadata contains metadata for the binary file to be uploaded.
The FileName, FieldName and ContentType in FileMetadata are optional. If left blank the FileName is derived from the FilePath, Fieldname is set to "file" and Content-Type is derived from the file present at the provided FilePath.
Eg. If it was a excel file the Content-Type would be automatically set as application/vnd.ms-excel.

The FieldMetadata should contain all the key/value pairs other than the binary file. If there are none, then leave this blank.

------------------------------
Shashank Kumar
DX Integrations Partner Consultant
Blue Prism
Singapore
+6581326707
------------------------------

RE: Web API Services - To upload a file using multipart form data

KiranSingh1 — Thu, 01 Dec 2022 12:10:00 GMT

Thank You @neiljor @shashank.kumar280,

API is working now.

------------------------------
Kiran Singh
------------------------------

RE: Web API Services - To upload a file using multipart form data

JishnuP_Nair1 — Wed, 09 Aug 2023 08:55:00 GMT

Hi @neiljor @shashank.kumar280
I am facing similar issue. Attaching screenshots for your reference.
If you could please reply back with correction and screenshots for better understanding.

Postman

Blueprism

------------------------------
Jishnu P Nair
------------------------------

RE: Web API Services - To upload a file using multipart form data

neiljor — Mon, 14 Aug 2023 09:31:00 GMT

Hi @Jishnu P Nair, I would suggest checking the force pre authorization setting, and your headers. For my use case I had to logon to the service using one API which returned a token that I had to use in an Authorization header for the upload call.

------------------------------
Neil Jordan
------------------------------

RE: Web API Services - To upload a file using multipart form data

JoãoCorreia — Wed, 21 Feb 2024 20:21:00 GMT

HI Community,

Could you guys help me?
I'm trying to upload a txt file to through the api, but im getting error 401 while doing it.
I already tried to upload others files extensions but i cant Understand why the .txt isnt working.
And another thing is that when i tried using Postman, the file go without issues.

------------------------------
João Correia
------------------------------