Files as octet streams

You can upload and download files as octet streams.

Note: Files sent from Nintex Workflow are sent using the header Transfer-Encoding: chunked, with no Content-Length header, in accordance with the HTTP spec.

How to upload and download files as octet streams

In the parameter or response object that represents the file, add:

  1. A type property of string.
  2. A format property of binary.

Where to use octet streams

You can use binary file encoding:

  • In the parameter object to upload a file to your API.
  • In the response object to download a file from your API.
Copy 
{
  "name": "body",
  "in": "body",
  "schema": {
    "type": "object",
    "properties": {
      "content": {
        "type": "string",
        "format": "binary"
      }
    }
  }
}