REST Attachments
Note
We have identified some use cases where ReadyAPI Windows users required broader character encoding through UTF-8. To set encoding to UTF-8, you need to make one configuration change to <readyapi-installation-folder>\bin\ReadyAPI.vmoptions. Insert a new line at the end and add -Dfile.encoding=UTF-8. Save, close the file, and open ReadyAPI. For additional details on setting the encoding to UTF-8, refer to the Unicode Support page.
REST sends attachments as MIME parts in a message with multipart/form-data media type.
Requirements
To send an attachment, your request must have a payload. For example, a GET request cannot have attachments, as it cannot have payload.
Sending a Request to REST Services
In the Message Body
To send an attachment to a REST service:
Open the Attachments panel and click
Add Attachment.
Select the file you want to send. ReadyAPI will ask you if want to cache it in the request. Uncached attachments are read from the file directly each time the request is sent. Cached attachments are stored in the project, so you can remove the original file.
Important
Open the Request editor and set the request media type as
multipart/form-dataormultipart/mixed.
Sending an attachment as a formData parameter
Some services require that you send attachments as a formData parameter in the body. In this case, additional configuration is required:
Attach the file to the project as described above.
Enable the Post QueryString option.
Make sure the parameter that you use to attach the file has the
QUERYtype. Then, specify the file to be attached by usingfile:filename.txtas a parameter value.Tip
You can specify
file:C:/<folder>/<filename>as a parameter value to attach a file from the computer. It will not be cached in the project.
In the Attachments panel, input the name of the parameter in the ContentID column.
