This function calls the 'exportFieldNames' function of the REDCap API.
The URI (uniform resource identifier) of the REDCap project. Required.
The user-specific string that serves as the password for a project. Required.
A boolean value indicating if
A list of options to pass to
The full list of configuration options accepted by the
httr package is viewable by executing
package and documentation is available at https://cran.r-project.org/package=httr.
As of REDCap version 6.14.2, three variable types are not returned in this call: calculated, file, and descriptive. All variables returned are writable/uploadable.
Currently, a list is returned with the following elements,
data: An R
base::data.frame() where each row represents one column in the readl dataset.
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_collapsed: The desired records IDs, collapsed into a single string, separated by commas.
fields_collapsed: The desired field names, collapsed into a single string, separated by commas.
filter_logic: The filter statement passed as an argument.
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.
The official documentation can be found on the 'API Help Page' and 'API Examples' pages on the REDCap wiki (ie, 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.
1 2 3 4 5 6 7
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.