API Data Provider - Online Help

DownloadFile

Download the content of a Document.

Input

Name Type Description
Id Long The Id of the Document to download.
LocalFilePath String The local file path, including the file name, where the downloaded Document will be saved. Used only if set; otherwise the content is returned in FileData per Encoding.
Encoding String The encoding to use for the FileData output when LocalFilePath is not set. NONE returns the raw content; BASE64 returns Base64-encoded content.

The allowed values are NONE, BASE64.

The default value is BASE64.

Result Set Columns

Name Type Description
FileData String If LocalFilePath is not specified, the content of the Document per Encoding. Otherwise, the path to the file containing the content.
Success String Returns true if the download succeeded.

Copyright (c) 2026 CData Software, Inc. - All rights reserved.
Build 26.0.9770.0