Working with Form Parameters
TIBCO Business Studio™ for BusinessWorks™ supports the use of form parameters as the media type in REST requests for POST, PUT, and PATCH operations. This is the only media type that can be used to transmit files.
For more information about how Form parameters are represented in JSON and XSD, see the Conversion Between JSON and XML in TIBCO Business Studio™ section .
Form parameters are applicable to POST, PUT, and PATCH operations only. They must be defined at the operation level only and cannot be defined at the binding level.
- Tag/Value (application/x-www-form-urlencoded) - Select this encoding for an operation, if you want to use form parameters of primitive data type of String, Integer, or Boolean in your operation. You cannot use this encoding to transmit files.
- Multipart (application/form-data) - Select this encoding for an operation, if you want to use form parameters of type String, Integer, Boolean, File/Binary, or File/Text in your operation. You can send or receive both text and binary files.
When you transmit a file using a form parameter, two elements get created in TIBCO Business Studio for BusinessWorks:
Creating Form Parameters
You can create form parameters in POST, PUT, and PATCH operations only. You can create or modify parameters for REST services that were created ground up in the TIBCO Business Studio for BusinessWorks without a Swagger file. For REST services that were created using a Swagger file that was imported into TIBCO Business Studio for BusinessWorks from an external source you can only view the parameters. You cannot create or modify the parameters in such services.