DownloadFile

Command, Introduced in version 25.9

POST https://localhost:8001/sv/001.1/api/v1/Common/ManageFiles/DownloadFile

Download a file from a file path.

Returns stream of the file content.

Required permission

Download file

Remarks

Prerequisites: This command requires Option Flag 239 (RestrictLocalFilePathsAccess) to be enabled. The specified file path must also be configured as available and accessible for the current user. Requests will fail if either of these prerequisites is not met.

Properties

Name	Type	Summary	Introduced in
FilePathId	Int64	The business key identifier of the file path where the file will be downloaded. Mandatory References FilePaths
FilePath	String	The relative path of the file to be downloaded, relative to the file path root. E.g. "file.txt" or "subfolder/file.txt". Avoid using absolute paths. Mandatory

Example

{
  "FilePathId": 0,
  "FilePath": null
}