General API Info
Supported Methods
Arms
Data Access Groups
Events
Field Names
Files
File Repository
Instruments
Logging
Metadata
Projects
Records
Repeating Instruments and Events
Reports
REDCap
Surveys
Users & User Privileges
User Roles
REDCap API Documentation
Method Name
Import DAGs
Description
This method allows you to import new DAGs (Data Access Groups) into a project or update the group name of any existing DAGs.
NOTE: DAGs can be renamed by simply changing the group name (data_access_group_name). DAG can be created by providing group name value while unique group name should be set to blank.
URL
Supported Request Method
Permissions Required
To use this method, you must have API Import/Update privileges *and* Data Access Groups 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.
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
dag
dag
action
import
import
format
csv, json, xml [default]
csv, json, xml [default]
data
Contains the attributes 'data_access_group_name' (referring to the group name) and 'unique_group_name' (referring to the auto-generated unique group name) of each DAG to be created/modified, in which they are provided in the specified format.
Contains the attributes 'data_access_group_name' (referring to the group name) and 'unique_group_name' (referring to the auto-generated unique group name) of each DAG to be created/modified, in which they are provided in the specified format.
JSON Example:
[{"data_access_group_name":"CA Site","unique_group_name":"ca_site"}
{"data_access_group_name":"FL Site","unique_group_name":"fl_site"},
{"data_access_group_name":"New Site","unique_group_name":""}]CSV Example:
data_access_group_name,unique_group_name
"CA Site",ca_site
"FL Site",fl_site
"New Site",XML Example:
<?xml version="1.0" encoding="UTF-8" ?>
<dags>
<item>
<data_access_group_name>CA Site</data_access_group_name>
<unique_group_name>ca_site</unique_group_name>
</item>
<item>
<data_access_group_name>FL Site</data_access_group_name>
<unique_group_name>fl_site</unique_group_name>
</item>
<item>
<data_access_group_name>New Site</data_access_group_name>
<unique_group_name></unique_group_name>
</item>
</dags>
Optional
ReturnsreturnFormat
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).
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).
Number of DAGs added or updated