File upload using HTTP\/HTTPS protocol, sometimes also known as multipart\/form-data POST. Many REST APIs support file upload using HTTP methods such as POST or PUT.<\/p>\n
Real-world scenarios:<\/b><\/p>\n First, you will have to download a FREE Trial of SSIS PowerPack<\/a> (It comes with many REST API Connectors and over 30+ functional tasks\/components)<\/p>\n The first method of uploading a file or posting data to the server from a local file is a RAW upload. To enable this you simply have to make sure 2 things.<\/p>\n When you don’t include a Key\/Value pair and only the filepath is found, then the request is treated as a RAW Upload. In raw uploads, the default content type is application\/octet-stream. If you want to put a custom Content-Type, then edit the Headers in the Grid.<\/p>\n The above technique can be used to read POST data content from a local file. Using this method, only one file can be uploaded. If the remote server supports multiple files (i.e., Multi-Part\/Form-Data POST), use the following process. See the screenshot below of the file content upload using Raw mode. We used Fiddler<\/a> to inspect the REST API Task’s Web requests.<\/p>\n POST file data using SSIS ( Raw file upload)<\/p><\/div>\n The second method for file upload is Multi-Part Upload. The advantage of using this method is that you can POST upload a key\/value pair along with single or multiple files. To use this method, you must make sure the API supports it on the other end. Use the steps below to POST data using the Multi-Part method.\u00a0 SSIS PowerPack detects RAW mode vs Multi-Part POST based on BODY content. If the Body contains an Equal sign somewhere and the File Upload option is checked, then it’s treated as a Multi-Part upload. If File Upload Option is checked and Body contains only file path which starts with @ sign then its treated as Raw content upload.<\/p>\n Click OK to Save above.<\/p>\n Uploading files using REST API in SSIS ( REST API File upload using Multipart form-data POST)<\/p><\/div><\/li>\n<\/ol>\n Now, let’s take a look at what it looks like in Fiddler<\/a>\u00a0when an actual\u00a0Multipart POST request<\/strong> is made for the REST API File upload. Notice that each field included in our HTTP POST request is separated by some random boundary. The REST API Task automatically generates this boundary. If you post an Image, then you will see binary data rather than text for file content. Here are some known issues<\/a> you need to be aware of.<\/p>\n HTTP Multipart POST – File Upload Example – Check Fiddler Request<\/p><\/div>\n Here is a Sample Multi-Part request.<\/strong><\/p>\n Notice a few things<\/p>\n <\/p>\n Sometimes you may receive the following error if your server is expecting \\r\\n after the last Multi-Part boundary. Here is the fix<\/a> for this error.<\/p>\n\n
How to do REST API File Upload using SSIS<\/h2>\n
\n
\nExample: http:\/\/myserver\/api\/v1\/uploaddata<\/li>\nMethod 1 – Upload file using Raw Mode (Or POST data from a local file)<\/h3>\n
\n
![\"\"](\"https:\/\/zappysys.com\/blog\/wp-content\/uploads\/2016\/06\/POST-file-data-using-SSIS-Raw-file-upload.png\")
<\/a>Method\u00a02 – Upload file(s) using Multi-Part \/ Form Data mode (Mixed content, multiple files)<\/h3>\n
\n
File1=@c:\\data\\somedata.txt\r\nFile1.Content-Type=text\/plain\r\nFile2=@c:\\data\\someimage.png\r\nFile2.Content-Type=image\/png\r\nSomefield1=abcdef\r\nSomefield2=123456\r\nExtrafield3WithNewLine=This is line1\\r\\nThis is line2 with tab\\t and more \\t tab\r\nSomefield3StartsWithAt=\\@MyTwitterHandle<\/pre>\n
file1=@c:\\temp\\dump.json\r\nfile1.Content-Type=<\/pre>\n<\/div><\/div><\/li>\n
![\"\"](\"https:\/\/zappysys.com\/blog\/wp-content\/uploads\/2016\/06\/Uploading-files-using-REST-API-in-SSIS-REST-API-File-upload-using-Multipart-form-data-POST.png\")
<\/a>Understanding Multipart Upload \/ File Upload<\/h2>\n
![\"HTTP](\"https:\/\/zappysys.com\/blog\/wp-content\/uploads\/2016\/06\/fiddler-http-multipart-form-data-example-rest-api-file-upload-post-1.png\")
<\/a>\n
POST https:\/\/somecompany.com\/downloads\/files\/test\/uploadtest.aspx HTTP\/1.1\r\nUser-Agent: ZappySysApp\/1.0.2019.10822\r\nx-custom-hdr: 69c05bf5b6ef48dbb73c55020c50e027\r\nContent-Type: multipart\/form-data; boundary=---------------------------WebKitFormBoundary55fd218185294c408e9ef21a4ac82825\r\nHost: somecompany.com\r\nContent-Length: 3619\r\nExpect: 100-continue\r\nAccept-Encoding: gzip, deflate\r\nConnection: Keep-Alive\r\n\r\n-----------------------------WebKitFormBoundary55fd218185294c408e9ef21a4ac82825\r\nContent-Disposition: form-data; name=\"File1\"; filename=\"MultiPartFileUpload1.txt\"\r\nContent-Type: text\/plain\r\n\r\nA000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\r\n-----------------------------WebKitFormBoundary55fd218185294c408e9ef21a4ac82825\r\nContent-Disposition: form-data; name=\"File2\"; filename=\"MultiPartFileUpload2.txt\"\r\nContent-Type: text\/plain\r\n\r\nB00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000\r\n-----------------------------WebKitFormBoundary55fd218185294c408e9ef21a4ac82825\r\nContent-Disposition: form-data; name=\"Extrafield1\"\r\n\r\naaaa\r\n-----------------------------WebKitFormBoundary55fd218185294c408e9ef21a4ac82825\r\nContent-Disposition: form-data; name=\"Extrafield2\"\r\n\r\nbbbb\r\n-----------------------------WebKitFormBoundary55fd218185294c408e9ef21a4ac82825\r\nContent-Disposition: form-data; name=\"Extrafield3WithNewLine\"\r\n\r\nThis is line1\r\nThis is line2 with tab\ttab\ttab\r\n-----------------------------WebKitFormBoundary55fd218185294c408e9ef21a4ac82825\r\nContent-Disposition: form-data; name=\"Extrafield3WithAt\"\r\n\r\n@MyTwitterHandle\r\n-----------------------------WebKitFormBoundary55fd218185294c408e9ef21a4ac82825--<\/pre>\n
Known Issues<\/h2>\n
The remote server returned an error: (500) Internal Server Error.\r\nResponse Url: https:\/\/your-host\/api\r\n\r\nStatus Code: InternalServerError \r\n\r\nResponse Body: {\"Message\":\"An error has occurred.\"\r\n,\"ExceptionMessage\":\"Unexpected end of MIME multipart stream. MIME multipart message is not complete.\",\"ExceptionType\":\"System.IO.IOException\",\"StackTrace\":\" at System.Net.Http.Formatting.Parsers.MimeMultipartBodyPartParser.<ParseBuffer>d__0.MoveNext()\\r\\n at System.Net.Http.HttpContentMultipartExtensions.MoveNextPart(MultipartAsyncContext context)\"\r\n}\r\n<\/pre>\nMost common extension and Content-Type<\/h2>\n