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 PDF file of Data Collection Instruments (either as blank or with data)

Description

This method allows you to export a PDF file for any of the following: 1) a single data collection instrument (blank), 2) all instruments (blank), 3) a single instrument (with data from a single record), 4) all instruments (with data from a single record), or 5) all instruments (with data from ALL records). This is the exact same PDF file that is downloadable from a project's data entry form in the web interface, and additionally, the user's privileges with regard to data exports will be applied here just like they are when downloading the PDF in the web interface (e.g., if they have de-identified data export rights, then it will remove data from certain fields in the PDF). If the user has 'No Access' data export rights, they will not be able to use this method, and an error will be returned.

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
pdf
Optional
record
the record ID. The value is blank by default. If record is blank, it will return the PDF as blank (i.e. with no data). If record is provided, it will return a single instrument or all instruments containing data from that record only.
event
the unique event name - only for longitudinal projects. For a longitudinal project, if record is not blank and event is blank, it will return data for all events from that record. If record is not blank and event is not blank, it will return data only for the specified event from that record.
instrument
the unique instrument name as seen in the second column of the Data Dictionary. The value is blank by default, which returns all instruments. If record is not blank and instrument is blank, it will return all instruments for that record.
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'.
allRecords
[The value of this parameter does not matter and is ignored.] If this parameter is passed with any value, it will export all instruments (and all events, if longitudinal) with data from all records. Note: If this parameter is passed, the parameters record, event, and instrument will be ignored.
compactDisplay
Set to TRUE to return a compact-formatted PDF that excludes fields that have no data saved and excludes unselected multiple choice options, thus producing a smaller PDF file. If set to FALSE, all fields will be displayed normally.
returnFormat
csv, json, xml [default] - The returnFormat is only used with regard to the format of any error messages that might be returned.
Returns

A PDF file containing one or all data collection instruments from the project, in which the instruments will be blank (no data), contain data from a single record, or contain data from all records in the project, depending on the parameters passed in the API request.

REDCap Software - Version 14.9.1 - © 2024 Vanderbilt University