This function uses REDCap's API to download a file.

redcap_survey_link_export_oneshot(
  redcap_uri,
  token,
  record,
  instrument,
  event = "",
  verbose = TRUE,
  config_options = NULL
)

Arguments

redcap_uri

The URI (uniform resource identifier) of the REDCap project. Required.

token

The user-specific string that serves as the password for a project. Required.

record

The record ID where the file is to be imported. Required

instrument

The name of the instrument associated with the survey link. Required

event

The name of the event where the file is saved in REDCap. Optional

verbose

A boolean value indicating if messages should be printed to the R console during the operation. Optional.

config_options

A list of options to pass to httr::POST() method in the 'httr' package. See the details below. Optional.

Value

Currently, a list is returned with the following elements,

  • success: A boolean value indicating if the operation was apparently successful.

  • status_code: The http status code of the operation.

  • outcome_message: A human readable string indicating the operation's outcome.

  • records_affected_count: The number of records inserted or updated.

  • affected_ids: The subject IDs of the inserted or updated records.

  • elapsed_seconds: The duration of the function.

  • raw_text: If an operation is NOT successful, the text returned by REDCap. If an operation is successful, the raw_text is returned as an empty string to save RAM.

  • file_name: The name of the file persisted to disk. This is useful if the name stored in REDCap is used (which is the default).

Details

Currently, the function doesn't modify any variable types to conform to REDCap's supported variables. See validate_for_write() for a helper function that checks for some common important conflicts.

Permissions Required To use this method, you must have API Export privileges in the project. (As stated in the 9.0.0 documentation.)

References

The official documentation can be found on the 'API Help Page' and 'API Examples' pages on the REDCap wiki (i.e., https://community.projectredcap.org/articles/456/api-documentation.html and https://community.projectredcap.org/articles/462/api-examples.html). If you do not have an account for the wiki, please ask your campus REDCap administrator to send you the static material.

Author

Will Beasley

Examples

if (FALSE) { uri <- "https://bbmc.ouhsc.edu/redcap/api/" token <- "8FA9A6BDAE2C0B5DD3CB472DD8E8918C" #pid=817 record <- 1 instrument <- "participant_morale_questionnaire" # event <- "" # only for longitudinal projects result <- REDCapR::redcap_survey_link_export_oneshot( record = record, instrument = instrument, redcap_uri = uri, token = token ) result$survey_link }