Downloads export file. — get_export

If the export file is ready, this function downloads it to the target directory specified in path. If the file is not ready, print a message describing the situation.

Usage

get_export_file(
  job_id,
  path,
  verbose = FALSE,
  server = Sys.getenv("SUSO_SERVER"),
  workspace = Sys.getenv("SUSO_WORKSPACE"),
  user = Sys.getenv("SUSO_USER"),
  password = Sys.getenv("SUSO_PASSWORD")
)

Arguments

job_id: Numeric. Export job ID
path: Character. File path where export file should be downloaded
verbose: Logical. If verbose = TRUE, return a logical value about the outcome. If verbose = FALSE, the default, simply return a message describing the outcome.
server: Character. Full server web address (e.g., https://demo.mysurvey.solutions, https://my.domain)
workspace: Character. Name of the workspace whose export files to get. In workspace list, value of NAME, not DISPLAY NAME, for the target workspace.
user: Character. API user name
password: Character. API password

Value

Logical. TRUE if file successfully downloaded; FALSE otherwise.

Details

Wrapper for GET /api/v2/export/{id}/file endpoint