Get list of export jobs

Get data frame of export jobs on the server. This includes jobs that have been started, cancelled, and completed. The data frame includes the job id as well as several attributes about the job.

Usage

get_export_jobs(
  export_type = "",
  interview_status = "All",
  qnr_id = "",
  export_status = "",
  has_file = NA,
  limit = 40,
  offset = 0,
  server = Sys.getenv("SUSO_SERVER"),
  workspace = Sys.getenv("SUSO_WORKSPACE"),
  user = Sys.getenv("SUSO_USER"),
  password = Sys.getenv("SUSO_PASSWORD")
)

Arguments

export_type

Character. Type of data to export. Values: c("Tabular", "STATA", "SPSS", "Binary", "DDI", "Binary")

interview_status

Character. Status of interviews to export. Values: c("All", "SupervisorAssigned", "InterviewerAssigned", "Completed", "RejectedBySupervisor", "ApprovedBySupervisor", "RejectedByHeadquarters", "ApprovedByHeadquarters")

qnr_id

Character. Questionnaire ID. Format: qnr_id$version

export_status

Character. Status of export process. Values: c("Created", "Running", "Completed", "Fail", "Canceled")

has_file

Logical. Whether export file generated.

limit

Number of results to return. Values: c(1:40)

offset

Offset in list of processes.

server

Full server web address (e.g., https://demo.mysurvey.solutions, https://my.domain)

workspace

Character. Name of the workspace whose export jobs to get. In workspace list, value of NAME, not DISPLAY NAME, for the target workspace.

user

API user name

password

API password

Value

Data frame of export jobs.

Details

Wrapper for GET /api/v2/export endpoint