Multipart request formats
- Format
-
The request can have these request formats:
- application/x-www-form-urlencoded - Define multipart request body by form-data parameters.
- multipart/form-data - Define multipart request body by form-data parameters.
- Form Data Parameters
- If the multipart request body format is selected the list of form parameters is displayed.
This table shows the description of available columns:
Column | Description |
---|---|
Name | The form-data parameter name as defined in the API metadata. An asterisk indicates whether it is required to pass a value for this parameter. |
Data Type | The parameter data type and optional data format as defined in API metadata. |
Content type | If parameter data type is ‘File’ or strings(binary) or string(base64), define content type. Default values are application/json for JSON Conventional input document, application/xml for BOD document, text/plain for ANY document. |
Value |
To specify a constant value to use in all API calls for the form-data parameter on this row, define the option in this column. You can use keywords to specify the value in this field. See Keywords. |
Path |
To specify path expressions, select the option in this column. At runtime, the path expression is replaced with the value from the input document. |
Input Document | To send a complete input document as the value of the form-data
parameter on this row, select the option in this column. You can define how an input document must be compressed.
|