GET api/v2/ftp?remoteFile={remoteFile}&extended={extended}

List the current or extended directory information specified by RemotePath on an FTP server. (for extended=true) This method is used to request a directory (or file mask) listing specified in RemoteFile. RemoteFile is either an absolute path on the server, or a path relative to RemotePath. Note that since RemoteFile acts as a file mask, to retrieve a complete directory listing RemoteFile should be set to empty string or a mask like "*".

Request Information

URI Parameters

Name	Description	Type	Additional information
remoteFile	Remote File	string	None.
extended	extended directory information flag	boolean	Default value is False

Body Parameters

None.

Response Information

Resource Description

Directory List

Collection of SuiteBridge.Models.Ftp.FtpDirectoryListResponse

Name	Description	Type	Additional information
DirEntry	The DirEntry parameter contains the filename when ListDirectory is called, and extended file information when ListDirectoryLong is called.	string	None.
FileName	File name	string	None.
FileSize	File Size	integer	None.
FileTime	Date Time stamp	string	None.
IsDir	Is Directory Flag	boolean	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "DirEntry": "sample string 1",
    "FileName": "sample string 2",
    "FileSize": 3,
    "FileTime": "sample string 4",
    "IsDir": true
  },
  {
    "DirEntry": "sample string 1",
    "FileName": "sample string 2",
    "FileSize": 3,
    "FileTime": "sample string 4",
    "IsDir": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfFtpDirectoryListResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <FtpDirectoryListResponse>
    <DirEntry>sample string 1</DirEntry>
    <FileName>sample string 2</FileName>
    <FileSize>3</FileSize>
    <FileTime>sample string 4</FileTime>
    <IsDir>true</IsDir>
  </FtpDirectoryListResponse>
  <FtpDirectoryListResponse>
    <DirEntry>sample string 1</DirEntry>
    <FileName>sample string 2</FileName>
    <FileSize>3</FileSize>
    <FileTime>sample string 4</FileTime>
    <IsDir>true</IsDir>
  </FtpDirectoryListResponse>
</ArrayOfFtpDirectoryListResponse>