Skip to content
English
Contact us
  • There are no suggestions because the search field is empty.

Understanding the Import cURL Command

Using the Import cURL Command

The Import cURL Command allows you to import data into your Ripple Registry or a specific study without using the Export Tool within Ripple. This process requires properly formatted data in an Excel spreadsheet that aligns with the Data Dictionary .

Understanding the Import cURL Command

Before running the command, ensure you have the following components:

  1. Ripple Site URL – The URL of the Ripple instance where you’re importing data.
  2. Import Type – Specifies whether the data is imported into the Registry or a specific study.
    • For a study, find the Import Type by checking the study’s URL in Ripple (a string of letters and numbers).
  3. Update Option – Defines how Ripple handles existing participants:
    • all → Update All Participants
    • nocontact → Do Not Update Contact Information
    • noexisting → Do Not Update Existing Participants
  4. Authorization Key – Your unique key that grants permission to import data.
  5. Excel File Name & Location – The file path on your device for the spreadsheet to be imported.

Example of an Import cURL Command

Below is an example demonstrating an import to a study:

Explanation of the Command:

  • https://successplayground.ripplescience.com → The Ripple site where data is being imported.
  • importType=STUDY_ID → Specifies that the import is for a specific study.
  • updateOption=all → Updates all participant information.
  • Authorization: Bearer YOUR_AUTH_KEY → Confirms the user’s identity and permissions.
  • file=@/Users/janedoe/Desktop/AncillaryA.xlsx → The Excel file being imported from Jane Doe’s Desktop.

Building & Running Your Own Import cURL Command

  1. Ensure your Excel file is formatted correctly based on the Data Dictionary.
  2. Identify the Import Type (for a study, use the ID from the study’s URL).
  3. Choose the correct Update Option for handling existing participants.
  4. Replace placeholders in the example command with your Ripple Site URL, Import Type, Authorization Key, and file location.
  5. Run the cURL command in a terminal or command prompt.

For detailed guidance, refer to Ripple’sImport cURL Command documentation .