v1

latestOpenAPI 3.0.1raw.githubusercontent.com2025-08-078639.0 KB

Download a file

Downloads an individual specified file from FSS.

get/batch/{batchId}/files/{filename}

Path parameters

batchIdstring GUID required

A Batch ID (GUID).

filenamestring required

Filename of the file.

Headers

Rangestring bytes=startByte-endByte or bytes=startByte-

Optional. Return file data only for the specified byte range.

Format 1: bytes=startByte-

This range will return bytes from the offset startByte through to the end of the file. For example, to specify a range encompassing all bytes after the first 256 bytes of a file, you can pass in the following header:

  Range: bytes=255-

The Content-Length header in the response is equal to the number of bytes from the offset until the end of the file. Using the example range above for a file of 1,024 bytes in length, Content-Length would be 769.

If the offset is valid and does not exceed the file’s total length, the request will return status code 206 (Partial Content). If the offset is invalid and exceeds the file’s total length, the request will return status code 416 (Range Not Satisfiable).

Format 2: bytes=startByte-endByte

This range will return bytes from the offset startByte through to the endByte. For example, to specify a range encompassing the first 512 bytes of a file, you would pass in the following header:

  Range: bytes=0-511

The Content-Length header in the response is equal to the number of bytes between each offset. Using the example range above for a file of 1,024 bytes in length, Content-Length would be 512.

If the offset is valid and does not exceed the file’s total length, the request will return status code 206 (Partial Content). If the offset is invalid and exceeds the file’s total length, the request will return status code 416 (Range Not Satisfiable).

See Microsoft documentation for more details on specifying the range header: https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-the-range-header-for-file-service-operations, the HTTP Range Requests specification: https://tools.ietf.org/html/rfc7233 or Byte serving information https://en.wikipedia.org/wiki/Byte_serving.

Response

OK - returns the file content.