OpenClinica API Calls

This page provides the APIs call for the OpenClinica; by calling these APIs, you can find out how much time the API call takes for a specific study. Follow the below steps to run the APIs.

1. Invoke API to get the token on the terminal.

curl -X POST --data '{"username": "demo_username", "password": "demo_password"}' -H "Content-Type: application/json" https://qlhc2.build.openclinica.io/user-service/api/oauth/token

https://qlhc2.build.openclinica.io will be OpenClinica server URL.

Note: Every time, you will get a new token when you run the auth API.

2. Invoke data API to get the study data

curl -X GET -H "Accept: application/xml" -H "Authorization: Bearer #1step_token" "https://qlhc2.openclinica.io/OpenClinica/pages/auth/api/clinicaldata/S_ISPY(TEST)/*/*/*?includeAudits=y&includeDNs=n&includeMedtadata=y&showArchived=n"

S_ISPY(TEST) will be the study OID from the OpenClinica.

#1step_token Use the token from #1 step.

After running the data API, you will know how much time it takes to invoke the study data.

Once you get the APIs' exact time, you can inform the OpenClinica team (client) to resolve the issue.

What is the need behind running these APIs?

When the ‘OpenClinica Study Data Importer’ job takes more time (20-30 minutes) than an expected threshold, it becomes difficult to test the configuration every time and run the job to sync in the data.

In this case, you can cross-check the time taken by the job to complete by running these APIs using a terminal outside the OpenSpecimen.