Object request formats without manual mapping

Format

The request can have these formats without manual mapping:

  • None: Request body is not sent.

  • application/json: JSON Conventional Input document is sent in the request body parameter.

  • application/x-ndjson: JSON newline-delimited input document is sent in the request body parameter.

  • BOD: BOD input document is sent in the request body parameter.

  • JSON from BOD: Noun part of the BOD input document is converted to JSON Conventional and sent in the request body parameter.

    Note: Select Respect source schema to generate JSON that follows the source BOD schema. When enabled, collections defined in the BOD schema are always represented as JSON arrays and the generated JSON structure mirrors the source schema hierarchy.

  • XML from BOD: Noun part of the BOD input document is sent in the request body parameter.

  • XML from JSON: JSON Conventional input document is converted to XML and sent in the request body parameter.

  • text/csv, text/tab-separated-values, text/plain: DSV input document is sent in the request body parameter.

  • Any other request content type: ANY input document is sent in the request body parameter.

Name
The name of the parameter of type body that is defined in the API metadata.
Description
The description of the parameter of type body that is defined in the API metadata.
Content encoding

You can define how an input document is compressed.

  • No compression

    No compression is selected by default. The input document is sent without compression.

  • Deflate

    When Deflate is selected, the input document is compressed by using the deflate algorithm, as described in RFC 1951. The compression uses a combination of the LZ77 algorithm and Huffman coding wrapped in the zlib data format that is described in RFC 1950.

Note: For sending binary content such as images, PDF files, or archive files, use an ANY document with the appropriate request content type to ensure that the data is transmitted in its native binary format without base64 encoding.

Set the request content type to match the target API expected format, for example, application/octet-stream for generic binary data or image/png for PNG images.

For multipart uploads where the file is one of several parameters, use the multipart/form-data request format instead.

See the Binary content section and Configuring form-data parameters for binary file uploads for additional guidance.