Working …
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:
REDCap
My Projects
Control Center

General API Info

Introduction
Obtaining API Tokens
API Error Codes & Responses
API Security & Best Practices
API Examples

Supported Methods

Arms
Export Arms
Import Arms
Delete Arms
Data Access Groups
Export DAGs
Import DAGs
Delete DAGs
Switch DAG
Export User-DAG Assignment
Import User-DAG Assignment
Events
Export Events
Import Events
Delete Events
Field Names
Export List of Export Field Names
Files
Export a File
Import a File
Delete a File
File Repository
Create a New Folder in the File Repository
Export a List of Files/Folders from the File Repository
Export a File from the File Repository
Import a File into the File Repository
Delete a File from the File Repository
Instruments
Export Instruments (Data Entry Forms)
Export PDF file of Instruments
Export Instrument-Event Mappings
Import Instrument-Event Mappings
Logging
Export Logging
Metadata
Export Metadata (Data Dictionary)
Import Metadata (Data Dictionary)
Projects
Create Project
Import Project Info
Export Project Info
Export Project XML
Records
Export Records
Import Records
Delete Records
Rename Record
Generate Next Record Name
Randomize Record
Repeating Instruments and Events
Export Repeating Instruments and Events
Import Repeating Instruments and Events
Reports
Export Reports
REDCap
Export REDCap Version
Surveys
Export a Survey Link
Export Survey Participants
Export a Survey Queue Link
Export a Survey Return Code
Users & User Privileges
Export Users
Import Users
Delete Users
User Roles
Export User Roles
Import User Roles
Delete User Roles
Export User-Role Assignment
Import User-Role Assignment
REDCap API Documentation
Method Name

Export a File

Description

This method allows you to download a document that has been attached to an individual record for a File Upload field. Please note that this method may also be used for Signature fields (i.e. File Upload fields with 'signature' validation type).

Note about export rights: Please be aware that Data Export user rights will be applied to this API request. For example, if you have 'No Access' data export rights in the project, then the API file export will fail and return an error. And if you have 'De-Identified' or 'Remove All Identifier Fields' data export rights, then the API file export will fail and return an error *only if* the File Upload field has been tagged as an Identifier field. To make sure that your API request does not return an error, you should have 'Full Data Set' export rights in the project.

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 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
file
action
export
record
the record ID
field
the name of the field that contains the file
event
the unique event name - only for longitudinal projects
repeat_instance
(only for projects with repeating instruments/events) The repeat instance number of the repeating event (if longitudinal) or the repeating instrument (if classic or longitudinal). Default value is '1'.
Optional
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 contents of the file

How to obtain the filename of the file:
The MIME type of the file, along with the name of the file and its extension, can be found in the header of the returned response. Thus in order to determine these attributes of the file being exported, you will need to parse the response header. Example: content-type = application/vnd.openxmlformats-officedocument.wordprocessingml.document; name='FILE_NAME.docx'

REDCap Software - Version 14.9.1 - © 2024 Vanderbilt University