redcap_file_repo_list_oneshot: Export a List of Files/Folders from the File Repository

In REDCapR: Interaction Between R and REDCap

Export a List of Files/Folders from the File Repository

Description

Allows you to export a list of all files and sub-folders from a specific folder in a project's File Repository. Each sub-folder will have an associated folder_id number, and each file will have an associated doc_id number.

Usage

redcap_file_repo_list_oneshot(
  redcap_uri,
  token,
  folder_id = NA_integer_,
  verbose = TRUE,
  config_options = NULL,
  handle_httr = NULL
)

Arguments

redcap_uri	The uri/url of the REDCap server typically formatted as "https://server.org/apps/redcap/api/". Required.
token	The user-specific string that serves as the password for a project. Required.
folder_id	the integer of a specific folder in the File Repository for which you wish to export a list of its files and sub-folders. If NA (the default), the top-level directory of the File Repository will be used.
verbose	A boolean value indicating if messages should be printed to the R console during the operation. Optional.
config_options	A list of options passed to httr::POST(). See details at httr::httr_options(). Optional.
handle_httr	The value passed to the handle parameter of httr::POST(). This is useful for only unconventional authentication approaches. It should be NULL for most institutions. Optional.

Details

This functions requires API Export privileges and File Repository privileges in the project. (Note: Until v14.7.3 Standard, API import privileges too.)

Value

Currently, a list is returned with the following elements,

• data: A tibble::tibble with the following columns: folder_id, doc_id, and (file) name. Each sub-folder will have an associated folder_id integer, and each file will have an associated doc_id integer.

• 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.

• 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.

Author(s)

Will Beasley

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.

Examples

## Not run: 
uri     <- "https://redcap-dev-2.ouhsc.edu/redcap/api/"
token   <- "589740603423E92BC79BAC2811B1F82A" # file-repo

# Top-level directory
REDCapR::redcap_file_repo_list_oneshot(
  redcap_uri    = uri,
  token         = token
)$data

# First subdirectory
REDCapR::redcap_file_repo_list_oneshot(
  redcap_uri    = uri,
  token         = token,
  folder_id     = 1
)$data


## End(Not run)

REDCapR documentation built on April 3, 2025, 6:20 p.m.