Get File List¶

Get latest file list

URI Template

GET /api/filetransfer/{instance}/{serviceName}/files

{instance}: Yamcs instance name
{serviceName}: File transfer service name

Query Parameters

source: Entity from which to get the file list
destination: Entity from which to get the file list
remotePath: Path of folder to list files from
options: Options for the transfer

Response Type

interface ListFilesResponse {
  files: RemoteFile[];
  destination: string;
  remotePath: string;
  listTime: string;  // RFC 3339 timestamp
  state: string;

  // Progress message, in case the file listing is still underway
  progressMessage: string;
}

Related Types

interface RemoteFile {

  // File identifier
  //
  // Typically, a remote file path, or a filename
  // in case of a flat file table.
  name: string;

  // Optional display name. Can be used when the ``name``
  // field contains information that should be hidden from the user.
  displayName: string;

  // True if the path represents a directory
  isDirectory: boolean;

  // File size
  size: string;  // String decimal

  // Modification time
  modified: string;  // RFC 3339 timestamp

  // Implementation-specific fields
  extra: {[key: string]: any};
}