get_export_job_details: Get detailed information about export process

In arthur-shaw/susoapi: Interface for Survey Solutions' APIs

Get detailed information about export process

Description

Get data frame of export job details for a single job. This provides a nice mechanism to inquire about the progress of recently started export jobs and see if they are complete.

Usage

get_export_job_details(
  job_id,
  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
server	Character. Full server web address (e.g., https://demo.mysurvey.solutions, https://my.domain)
workspace	Character. Name of the workspace whose export job details to get. In workspace list, value of NAME, not ⁠DISPLAY NAME⁠, for the target workspace.
user	Character. API user name
password	Character. API password

Details

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

Value

If job found, data frame of export job details. Otherwise, message about why the job was not found.

arthur-shaw/susoapi documentation built on Oct. 15, 2024, 3:44 a.m.