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 Arms
Description
This method allows you to import Arms into a project or to rename existing Arms in a project. You may use the parameter override=1 as a 'delete all + import' action in order to erase all existing Arms in the project while importing new Arms. Notice: Because of the 'override' parameter's destructive nature, this method may only use override=1 for projects in Development status.
NOTE: This only works for longitudinal projects.
URL
Supported Request Method
Permissions Required
To use this method, you must have API Import/Update privileges *and* Project Design/Setup 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
arm
arm
override
0 - false [default], 1 - true — You may use override=1 as a 'delete all + import' action in order to erase all existing Arms in the project while importing new Arms. If override=0, then you can only add new Arms or rename existing ones.
0 - false [default], 1 - true — You may use override=1 as a 'delete all + import' action in order to erase all existing Arms in the project while importing new Arms. If override=0, then you can only add new Arms or rename existing ones.
action
import
import
format
csv, json, xml [default]
csv, json, xml [default]
data
Contains the attributes 'arm_num' (referring to the arm number) and 'name' (referring to the arm's name) of each arm to be created/modified, in which they are provided in the specified format.
Contains the attributes 'arm_num' (referring to the arm number) and 'name' (referring to the arm's name) of each arm to be created/modified, in which they are provided in the specified format.
JSON Example:
[{"arm_num":"1","name":"Drug A"},
{"arm_num":"2","name":"Drug B"},
{"arm_num":"3","name":"Drug C"}]CSV Example:
arm_num,name
1,Drug A
2,Drug B
3,Drug CXML Example:
<?xml version="1.0" encoding="UTF-8" ?>
<arms>
<item>
<arm_num>1</arm_num>
<name>Drug A</name>
</item>
<item>
<arm_num>2</arm_num>
<name>Drug B</name>
</item>
<item>
<arm_num>3</arm_num>
<name>Drug C</name>
</item>
</arms>
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 Arms imported