Request Body tab

This tab contains the properties of the request body parameter. If the selected operation does not have a request body parameter, the controls on this tab are disabled.

These are the two main types of request formats used by APIs:

• Object - A request body can contain one object such as JSON or XML. You can define the object request body in these ways:
  • Sending an input document.
  • Manually define a request body and map parts of an input document by path expressions.
• Multipart - Request body application/x-www-form-urlencoded or multipart/form-data is defined using form-data parameters. You can define individual parameters using static value, path expression from an input document or send the complete input document.

Format

Here you can select the request format of the request body. An asterisk indicates whether it is required to define a request body parameter. If not required, you can select "None" request format and no request body is sent. A list of available request formats is defined by these criteria:

• The type of the selected input document.
• If the Map input document to API request check box is selected.
• Request content types that are available in API.