File Transfer

Upload File

Uploads a file to a specific path, and optionally, immediately import that file.

SecurityJWT
Request
path Parameters
fileSystem
required
string
path
required
string
query Parameters
cipher
required
string

Name of the encryption to apply.

import
required
boolean

Whether to immediately import the configuration file after uploading.

busUnitId
required
integer <int32>

Optional business unit id

Request Body schema: multipart/form-data
object (MultipartBody)
Responses
200

Success

400

Bad Request

500

Internal Server Error

post/fileTransfer/uploadFile/{fileSystem}/{path}
Request samples 
Deprecated Upload
SecurityJWT 
Request 
Request Body schema: multipart/form-data
object (MultipartBody) 
 
post/fileTransfer/upload
Request samples 
List Files
Get a list of files for the given path and the user's authorized business unit.


SecurityJWT 
Request 
path Parameters
fileSystem
required
string
 
path
required
string
 
query Parameters
includeSubDirs
required
boolean
 
includeHidden
required
boolean
 
modifiedBefore
required
string
 
 Example:  modifiedBefore=2023-03-29T13:10:17.757-05
modifiedAfter
required
string
 
 Example:  modifiedAfter=2023-03-29T13:10:17.757-05
busUnitId
required
integer <int32> 
Optional business unit id


 
Responses 
200
Success


500
Internal Server Error


get/fileTransfer/listFiles/{fileSystem}/{path}
Request samples 
Download File
Downloads a specific file.


SecurityJWT 
Request 
path Parameters
fileSystem
required
string
 
path
required
string
 
query Parameters
cipher
required
string
Name of the encryption to apply.


 
postXferAction
required
string
 
postXferData
required
string
Data associated with the postXferAction, including the directory name for a move action, or the file name suffix for an add suffix action.


 
busUnitId
required
integer <int32> 
Optional business unit id


 
Responses 
200
Success


404
Not Found


500
Internal Server Error


get/fileTransfer/downloadFile/{fileSystem}/{path}
Request samples 
Deprecated Download
SecurityJWT 
Request 
query Parameters
BusUnitId
required
integer <int32> 
 
fileSystem
required
string
 
serverFolder
required
string
 
cipher
required
string
Name of the encryption to apply.


 
fileName
required
string
 
get/fileTransfer/download
Request samples 
➔ Next to FinCapture Deposits