-
Notifications
You must be signed in to change notification settings - Fork 88
redcap export metadata
Jonathan Chan edited this page May 11, 2018
·
13 revisions
redcap-export-metadata exports the Metadata (i.e. Data Dictionary) for a REDCap project.
| Parameter | Description |
|---|---|
| host | Server hostname |
| token | Authentication token (project and user specific!) |
| xargs | Optional parameters; see below |
Optional parameters must come in pairs of 'symbol "string".
| Optional Parameter | Description |
|---|---|
| 'format "" | Sets desired output format to "<your_format>", which can be one of "csv", "xml", or "json". Default is "json", which will return a list of lists. |
| 'forms "" | Retrieves metadata for the given form. |
| 'fields "" | Retrieves metadata for the given field. |
Example 1: Exporting metadata of a project.
> ;;Testing Export Metadata function
> (define redcap:token "54CC....CC10")
> (define redcap:hostname "redcap.INSTITUTIONNAME.ca")
> (redcap-export-metadata redcap:hostname redcap:token)
((("field_name" . "participant_id")
("form_name" . "demographics")
("section_header" . "")
("field_type" . "text")
("field_label" . "Participant ID")
("select_choices_or_calculations" . "")
("field_note" . "")
("text_validation_type_or_show_slider_number" . "")
("text_validation_min" . "")
("text_validation_max" . "")
("identifier" . "")
("branching_logic" . "")
("required_field" . "")
("custom_alignment" . "")
("question_number" . ""))
[...]