gen_list_jobs: gen_list_jobs

In restatis: R Wrapper to Access a Wide Range of Germany's Federal Statistical System Databases Based on the GENESIS Web Service RESTful API of the German Federal Statistical Office (Statistisches Bundesamt/Destatis)

gen_list_jobs

Description

Function to list all current jobs connected to the given user in the GENESIS or regionalstatistik.de database. Important note: For this function it is also possible to use searchcriterion parameter and selection parameter, making it possible to filter the job list based on 'type','time','status' or 'code'. For more details see vignette("additional_parameter").

Usage

gen_list_jobs(
  database = c("genesis", "regio"),
  sortcriterion = c("type", "time", "status", "code"),
  flat = FALSE,
  error.ignore = FALSE,
  verbose = TRUE,
  ...
)

Arguments

database	Character string. Indicator if 'genesis' or 'regionalstatistik.de' database is called.
sortcriterion	Character string. Indicator if the output should be sorted by 'type','time','status' or 'code'. This is a parameter of the API call itself. The default is 'type'.
flat	Boolean. Should the function return a list with jobs and metadata ('FALSE') or just a flat data.frame ('TRUE')? Defaults to FALSE.
error.ignore	Boolean. Indicator if the function should stop if an error occurs or no object for the request is found or if it should produce a token as response. Default option is 'FALSE'. Important note: This does not apply to errors generated by the API call itself (especially server or client errors with status codes 5xx or 4xx). In this case, the function call will error even if error.ignore is set to TRUE.
verbose	Boolean. Indicator if the output of the function should include detailed messages and warnings. Default option is 'TRUE'. Set the parameter to 'FALSE' to suppress additional messages and warnings.
...	Additional parameters for the API call. These parameters are only affecting the call itself, no further processing. For more details see vignette("additional_parameter").

Details

Important information concerning the caching of results: This function's results are never cached because there is no use-case for a cached list of jobs (users would always want a refreshed list of jobs and their respective status).

Value

A list or data.frame (see parameter 'flat') of all current jobs of the user.

Examples

## Not run: 
gen_list_jobs("regio", flat = TRUE)

## End(Not run)

restatis documentation built on April 12, 2025, 1:28 a.m.