REDCap

The code block below illustrates how one might use # and // as comments in your logic and calculations.

This value you provided is not a number. Please try again.

This value you provided is not an integer. Please try again.

The value entered is not a valid Vanderbilt Medical Record Number (i.e. 4- to 9-digit number, excluding leading zeros). Please try again.

The value you provided must be within the suggested range

The value you provided is outside the suggested range

This value is admissible, but you may wish to double check it.

The value entered must be a time value in the following format HH:MM within the range 00:00-23:59 (e.g., 04:32 or 23:19).

This field must be a 5 or 9 digit U.S. ZIP Code (like 94043). Please re-enter it now.

This field must be a 10 digit U.S. phone number (like 415 555 1212). Please re-enter it now.

This field must be a valid email address (like joe@user.com). Please re-enter it now.

The value you provided could not be validated because it does not follow the expected format. Please try again.

Required format:

mJSEuuJza8TiJMCeck4kNW5fwVXtWbNGtkICengc64jQGeBc43GXpRdLEWzWujXagBfC8FzZYRYPnoPtUzjNzyUmL8kELaDrihsQWSmxkw33oEpxwGZCHqQFdPh

The code block below illustrates how one might use # and // as comments in your logic and calculations.

REDCap API Documentation

Method Name

Export a List of Files/Folders from the File Repository

Description

This method allows you to export a list of all files and subfolders 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.

URL

https://chi-redcap.dshs.texas.gov/redcap/api/

Supported Request Method

POST

Permissions Required

To use this method, you must have API Export privileges and File Repository privileges in the project.

Parameters (case sensitive)

Required

token
The API token specific to your REDCap project and username (each token is unique to each user for each project). See the section on the left-hand menu for obtaining a token for a given project.

content
fileRepository

action
list

format
csv, json, xml [default]

Optional

folder_id
the folder_id of a specific folder in the File Repository for which you wish to export a list of its files and subfolders. If none is provided, the top-level directory of the File Repository will be used.

returnFormat
csv, json, xml - specifies the format of error messages. If you do not pass in this flag, it will select the default format for you passed based on the 'format' flag you passed in or if no format flag was passed in, it will default to 'xml'.
NOTE: Does not apply when importing as a background process (i.e., backgroundProcess=true). When using a background process, success:true (upon success) or success:false (upon failure) will be returned in the appropriate format (csv, json, xml).

Returns

The list of all files and folders within a given sub-folder in the File Repository in the format specified.

General API Info

Supported Methods