This adapter does not use configuration settings.
|
CopyFile
|
Copy a file from one location to another
details
Arguments
|
Name
|
Description
|
Default |
|
srcFspec R
|
Source filespec
|
|
|
dstFspec R
|
Destination filespec. If only a directory is given the source file name is used.
|
|
|
recurseSubDirs
|
Recurse subdirectories
|
False |
|
overwrite
|
Overwrite any existing destinatio file
|
False |
SQL Call
exec bsc.Files.CopyFile '\\ServerA\path\fspec.ext', '\\ServerB\path\fspec.ext'
exec bsc.Files.CopyFile '\\ServerA\path\fspec.ext', '\\ServerB\path' -- file copied as source file name
Http Call
/bsc/files/copyfile
Output Columns
| String Name | | | String Path | | | String Extension | | | Int64 Size | | | Int64 CompressedSize | | | DateTime CreationTime | | | DateTime LastWriteTime | | | DateTime LastAccessTime | | | Int32 ExternalFileAttributes | | | Boolean IsArchive | | | Boolean IsCompressed | | | Boolean IsDirectory | | | Boolean IsEncrypted | | | Boolean IsHidden | | | Boolean IsOffline | | | Boolean IsReadOnly | | | Boolean IsSystem | | | Boolean IsTemporary | | | DateTime CreationTimeUtc | | | DateTime LastWriteTimeUtc | | | DateTime LastAccessTimeUtc | | | Int32 FileIndex | | | String Comment | | | String FilePattern | | | Boolean IncludeSubdirectories | | | String Password | |
|
|
DeleteFile
|
Delete the specified file
details
Arguments
|
Name
|
Description
|
Default |
|
fspec R
|
File specification to delete
|
|
SQL Call
exec bsc.Files.DeleteFile '\\server\path\file.ext'
delete from Files.Files where fspec = '\\server\path\file.ext'
delete from Files.Files where fspec = '\\server\path\*.tmp'
Http Call
/bsc/files/deletefile
Output Columns
This call does not return data.
|
|
Directory
|
List the contents of a UNC path.
details
Arguments
|
Name
|
Description
|
Default |
|
path R
|
UNC path to search
|
|
|
filePattern
|
The search string to match against the file-system entries in path. Wildcard specifiers are: *: Zero or more characters, ?: Exactly one character
|
* |
|
includeSubdirectories
|
Include traversing subdirectories
|
False |
SQL Call
select Files.ListDir '\\myserver\myshare\mydir', '*.zip', '2013-12-25 23:11:00'
Http Call
/bsc/files/directory
Output Columns
| String Name | | | String Path | | | String Extension | | | Int64 Size | | | Int64 CompressedSize | | | DateTime CreationTime | | | DateTime LastWriteTime | | | DateTime LastAccessTime | | | Int32 ExternalFileAttributes | | | Boolean IsArchive | | | Boolean IsCompressed | | | Boolean IsDirectory | | | Boolean IsEncrypted | | | Boolean IsHidden | | | Boolean IsOffline | | | Boolean IsReadOnly | | | Boolean IsSystem | | | Boolean IsTemporary | | | DateTime CreationTimeUtc | | | DateTime LastWriteTimeUtc | | | DateTime LastAccessTimeUtc | | | Int32 FileIndex | | | String Comment | | | String FilePattern | | | Boolean IncludeSubdirectories | | | String Password | |
|
|
Existence
|
Check for the existence of a file or directory
details
Arguments
|
Name
|
Description
|
Default |
|
fspec R
|
File specification to check
|
|
SQL Call
exec bsc.Files.Existence '\\server\path\file.ext'
select * from Files.Existence where fspec = '\\server\path\file.ext'
Http Call
/bsc/files/existence
Output Columns
| String fspec | | | Boolean Exists | |
|
|
ListDir
|
List the contents of a UNC path.
details
Arguments
|
Name
|
Description
|
Default |
|
path R
|
UNC path to search
|
|
|
filePattern
|
The search string to match against the file-system entries in path. Wildcard specifiers are: *: Zero or more characters, ?: Exactly one character
|
* |
|
afterDateTime
|
Only return files created or modified after this date/time
|
|
|
includeSubdirectories
|
Include traversing subdirectories
|
False |
|
isUTC
|
afterDateTime is UTC
|
False |
|
maxCount
|
Number of files to return; 0 for all files.
|
|
SQL Call
exec Files.ListDir '\\myserver\myshare\mydir', '*.zip', '2013-12-25 23:11:00'
Http Call
/bsc/files/listdir
Output Columns
| String Name | | | String Path | | | String Extension | | | Int64 Size | | | Int64 CompressedSize | | | DateTime CreationTime | | | DateTime LastWriteTime | | | DateTime LastAccessTime | | | Int32 ExternalFileAttributes | | | Boolean IsArchive | | | Boolean IsCompressed | | | Boolean IsDirectory | | | Boolean IsEncrypted | | | Boolean IsHidden | | | Boolean IsOffline | | | Boolean IsReadOnly | | | Boolean IsSystem | | | Boolean IsTemporary | | | DateTime CreationTimeUtc | | | DateTime LastWriteTimeUtc | | | DateTime LastAccessTimeUtc | | | Int32 FileIndex | | | String Comment | | | String FilePattern | | | Boolean IncludeSubdirectories | | | String Password | |
|
|
ListZIP
|
List the contents of a ZIP file.
details
Arguments
|
Name
|
Description
|
Default |
|
path R
|
UNC path of ZIP file to search
|
|
|
filePattern
|
The search string to match against the file-system entries in path. Wildcard specifiers are: *: Zero or more characters, ?: Exactly one character
|
* |
|
afterDateTime
|
Only return files created or modified after this date/time
|
|
|
password
|
Optional ZIP file password
|
|
|
maxCount
|
Number of files to return; 0 for all files.
|
|
SQL Call
exec Files.ListZIP '\\myserver\myshare\mydir\my.zip', '*.txt', '2013-12-25 23:11:00'
Http Call
/bsc/files/listzip
Output Columns
| String Name | | | String Path | | | String Extension | | | Int64 Size | | | Int64 CompressedSize | | | DateTime CreationTime | | | DateTime LastWriteTime | | | DateTime LastAccessTime | | | Int32 ExternalFileAttributes | | | Boolean IsArchive | | | Boolean IsCompressed | | | Boolean IsDirectory | | | Boolean IsEncrypted | | | Boolean IsHidden | | | Boolean IsOffline | | | Boolean IsReadOnly | | | Boolean IsSystem | | | Boolean IsTemporary | | | DateTime CreationTimeUtc | | | DateTime LastWriteTimeUtc | | | DateTime LastAccessTimeUtc | | | Int32 FileIndex | | | String Comment | | | String FilePattern | | | Boolean IncludeSubdirectories | | | String Password | |
|
|
MoveFile
|
Move a file from one location to another
details
Arguments
|
Name
|
Description
|
Default |
|
srcFspec R
|
Source filespec
|
|
|
dstFspec R
|
Destination filespec. If only a directory is given the source file name is used.
|
|
|
recurseSubDirs
|
Recurse subdirectories
|
False |
|
overwrite
|
Overwrite any existing destinatio file
|
False |
SQL Call
exec bsc.Files.MoveFile '\\ServerA\path\fspec.ext', '\\ServerB\path\fspec.ext'
exec bsc.Files.MoveFile '\\ServerA\path\fspec.ext', '\\ServerB\path' -- file moved as source file name
Http Call
/bsc/files/movefile
Output Columns
| String Name | | | String Path | | | String Extension | | | Int64 Size | | | Int64 CompressedSize | | | DateTime CreationTime | | | DateTime LastWriteTime | | | DateTime LastAccessTime | | | Int32 ExternalFileAttributes | | | Boolean IsArchive | | | Boolean IsCompressed | | | Boolean IsDirectory | | | Boolean IsEncrypted | | | Boolean IsHidden | | | Boolean IsOffline | | | Boolean IsReadOnly | | | Boolean IsSystem | | | Boolean IsTemporary | | | DateTime CreationTimeUtc | | | DateTime LastWriteTimeUtc | | | DateTime LastAccessTimeUtc | | | Int32 FileIndex | | | String Comment | | | String FilePattern | | | Boolean IncludeSubdirectories | | | String Password | |
|
|
ZIPfile
|
List the contents of a ZIP file.
details
Arguments
|
Name
|
Description
|
Default |
|
path R
|
UNC path of ZIP file to search
|
|
|
filePattern
|
The search string to match against the file-system entries in path. Wildcard specifiers are: *: Zero or more characters, ?: Exactly one character
|
* |
|
password
|
Optional ZIP file password
|
|
SQL Call
select * from Files.ZIPfile where [path] = '\\myserver\myshare\mydir\my.zip' and filePattern = '*.txt' and CreationTime >= '2013-12-25 23:11:00'
Http Call
/bsc/files/zipfile
Output Columns
| String Name | | | String Path | | | String Extension | | | Int64 Size | | | Int64 CompressedSize | | | DateTime CreationTime | | | DateTime LastWriteTime | | | DateTime LastAccessTime | | | Int32 ExternalFileAttributes | | | Boolean IsArchive | | | Boolean IsCompressed | | | Boolean IsDirectory | | | Boolean IsEncrypted | | | Boolean IsHidden | | | Boolean IsOffline | | | Boolean IsReadOnly | | | Boolean IsSystem | | | Boolean IsTemporary | | | DateTime CreationTimeUtc | | | DateTime LastWriteTimeUtc | | | DateTime LastAccessTimeUtc | | | Int32 FileIndex | | | String Comment | | | String FilePattern | | | Boolean IncludeSubdirectories | | | String Password | |
|
