Wiki source code of Multipart form-data
Last modified by Erik Bakker on 2024/06/17 11:39
Hide last authors
| author | version | line-number | content |
|---|---|---|---|
 |
2.1 | 1 | {{container}}{{container layoutStyle="columns"}}((( |
| |
18.1 | 2 | Sometimes when you call an external REST endpoint, they require you to send meta information and one or more "attachments" in one call to the REST endpoint. To make this possible, you need to send the information with the contentType called multipart/form-data. In this microlearning, we will discuss how you can configure a valid message within the eMagiz platform that allows you to send out messages with this contentType and have them accepted by the endpoint in question. |
| |
1.1 | 3 | |
| |
2.1 | 4 | Should you have any questions, please get in touch with [[academy@emagiz.com>>mailto:academy@emagiz.com]]. |
| |
1.1 | 5 | |
| 6 | == 1. Prerequisites == | ||
| 7 | |||
| |
6.1 | 8 | * Expert knowledge of the eMagiz platform |
| |
1.1 | 9 | |
| 10 | == 2. Key concepts == | ||
| 11 | |||
| |
18.1 | 12 | This microlearning focuses on configuring a multipart/form-data message within eMagiz to ensure it is sent correctly to an endpoint. |
| |
1.1 | 13 | |
| |
18.1 | 14 | Key aspects are: |
| |
1.1 | 15 | |
| |
18.1 | 16 | * Defining the boundary that separates the parts of the message |
| 17 | * Defining the content types of each part of the message | ||
| 18 | * Construction of the complete message according to the specification | ||
| |
1.1 | 19 | |
| |
18.1 | 20 | == 3. Multipart form-data == |
| |
1.1 | 21 | |
| |
18.1 | 22 | Sometimes when you call an external REST endpoint, they require you to send meta information and one or more "attachments" in one call to the REST endpoint. To make this possible, you need to send the information with the contentType called multipart/form-data. In this microlearning, we will discuss how you can configure a valid message within the eMagiz platform that allows you to send out messages with this contentType and have them accepted by the endpoint in question. |
| 23 | |||
| 24 | Key aspects are: | ||
| 25 | |||
| 26 | * Defining the boundary that separates the parts of the message | ||
| 27 | * Defining the content types of each part of the message | ||
| 28 | * Construction of the complete message according to the specification | ||
| 29 | |||
| |
23.1 | 30 | {{info}} |
| 31 | The following criteria apply when utilizing the boundary functionality within the multipart/form-data construction: | ||
| 32 | * The value of the Boundary must begin with a double horizontal bar –, this is called a leading hyphen | ||
| 33 | * The value of the Boundary must not contain more than 70 characters in addition to the leading hyphen. | ||
| 34 | * The value of the Boundary must not contain characters that are disabled by the HTTP protocol or the URL, such as the colon: etc. | ||
| 35 | * A boundary within the request body must always be preceeded by a CRLF line. This means that when the request body **ends** with a CRLF line an **additional** CRLF line is needed **before** the boundary doubling the CRLF lines in that part of the request body.{{/info}} | ||
| 36 | |||
| |
20.1 | 37 | === 3.1 Prepare the message === |
| |
18.1 | 38 | |
| |
20.1 | 39 | To construct the message, several steps are needed to make it work. Luckily, most of the steps necessary have to do with concepts we have already discussed in previous microlearnings. As you can imagine, based on what multipart/form-data entails, we need a way to both store the meta information and the file(s) we want to send to the external party. For example, put the metadata in one (or multiple) header(s) and use the file content as a payload. This you can achieve with a header enricher and standard transformer. |
| |
18.1 | 40 | |
| |
20.1 | 41 | Once the file content is your payload, you must ensure that the data is "raw." So when you have a base64 encoded string, you should decode it before sending it to the endpoint. |
| |
18.1 | 42 | |
| |
20.1 | 43 | On top of that, we need to define the contentType header. |
| 44 | |||
| |
19.1 | 45 | [[image:Main.Images.Microlearning.WebHome@expert-data-handling-multipart-form-data--content-type-header-config.png]] |
| 46 | |||
| |
20.1 | 47 | === 3.2 Construct the message === |
| |
19.1 | 48 | |
| |
20.1 | 49 | After you have set the stage, you can use a standard transformer component to build your message correctly. To create it correctly, you need to take the following into account: |
| 50 | |||
| 51 | * Each part of the message needs to be separated by a boundary | ||
| |
19.1 | 52 | * The message needs to start with a boundary and finish with a boundary |
| 53 | * Line breaks are needed to differentiate between the boundary and the text content | ||
| |
20.1 | 54 | * No line break is needed when the content is not text-based |
| |
19.1 | 55 | |
| |
20.1 | 56 | Given all this, you can write the following SpEL expression that will yield a desirable output: |
| |
19.1 | 57 | |
| |
20.1 | 58 | {{code}}'${multi-part-form-data.data-handling.boundary}' + headers.metaInfo + T(com.emagiz.util.Newline).CRLF.characters + '${multi-part-form-data.data-handling.boundary}' + T(com.emagiz.util.Newline).CRLF.characters + 'Content-Disposition: form-data; name="file"; filename="' + headers.filename + '"' + T(com.emagiz.util.Newline).CRLF.characters + 'Content-Type: application/pdf' + T(com.emagiz.util.Newline).CRLF.characters + T(com.emagiz.util.Newline).CRLF.characters + payload + '${multi-part-form-data.data-handling.boundary}'{{/code}} |
| |
19.1 | 59 | |
| |
20.1 | 60 | Putting this in a standard transformation gives you the following solution in the flow. |
| |
1.1 | 61 | |
| |
20.1 | 62 | [[image:Main.Images.Microlearning.WebHome@expert-data-handling-multipart-form-data--standard-transformer-config.png]] |
| |
1.1 | 63 | |
| |
20.1 | 64 | === 3.3 Calling the endpoint === |
| |
1.1 | 65 | |
| |
20.1 | 66 | Now that we have constructed our message correctly, the last thing to do is call the endpoint in question. Since we have prepared our message and accurately defined our contentType calling the endpoint does not require any additional configurations compared to what you are already used to when dealing with REST endpoints. |
| |
1.1 | 67 | |
| |
22.1 | 68 | == 4. Key takeaways == |
| |
1.1 | 69 | |
| |
20.1 | 70 | * Make sure to define the boundary that separates the parts of the message |
| 71 | * Make sure to define the content types of each part of the message | ||
| 72 | * Make sure to define the content type that matches the specification for multipart/form-data | ||
| 73 | * Construct the complete message according to the specification | ||
| |
1.1 | 74 | |
| |
22.1 | 75 | == 5. Suggested Additional Readings == |
| |
1.1 | 76 | |
| |
20.1 | 77 | If you are interested in this topic, please read the help texts on the platform and read the following link: |
| |
1.1 | 78 | |
| |
21.1 | 79 | * [[Multipart form-data explained>>https://www.sobyte.net/post/2021-12/learn-about-http-multipart-form-data/||target="blank"]] |
| |
18.1 | 80 | |
| |
22.1 | 81 | )))((({{toc/}}))){{/container}}{{/container}} |