Cancel export process — cancel

Has server-side side-effect of cancelling an active export process. A message will inform about the outcome. If verbose = TRUE, the function also returns a logical value: TRUE if cancellation successful; FALSE otherwise.

Usage

cancel_export(
  job_id,
  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
verbose: Logical. If verbose = TRUE, return TRUE if cancellation successful, FALSE otherwise
server: Character. Full server web address (e.g., https://demo.mysurvey.solutions, https://my.domain)
workspace: Character. Name of the workspace whose export jobs to cancel. In workspace list, value of NAME, not DISPLAY NAME, for the target workspace.
user: Character. API user name
password: Character. API password

Value

If verbose = FALSE, no return value. If verbose = TRUE, return logical outcome.

Details

Wrapper for DELETE /api/v2/export/{id} endpoint