Versions Compared

Old Version 9

changes.mady.by.user Prayuja Teli (Unlicensed)

Saved on

compared with

New Version Current

changes.mady.by.user Prayuja Teli (Unlicensed)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info

Page Under Development

This page explains how to find use the APIs to:

  • Find the API

...

  • call time.

  • Check connection to OC.

  • Verify API based authentication

Why run 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.

Steps to run the APIs

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

Expand
titleClick to expand

Code Block
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

In

...

above code,

...

‘POST’ and ‘Content-Type’ will remain fixed.

Code that will

...

vary

Server credentials: Username and password

Server URL: https://qlhc2.build.openclinica.io will be your

...

OC server URL

Once you run the above code, you will receive a token as shown in the below image.

...

Info

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

https://qlhc2.build.openclinica.io: This URL comprises 4 parts

...

, i.e., protocol, hostname, port, and

...

path.

...

  • Protocol: Decides language used for communication between the

...

  • client and the server.

...

  • Hostname: Server placement.

...

The port number is optional. When not specified, the protocol defined standard port is used. For https, it is 443. For http, it is 80.

  • Port number: Optional; default 443 for HTTPS; 80 for HTTP

  • Path: Decides the location of the resource

...

  • . When not specified, it is /

After invoking auth API, you will receive a token, as shown below.

Image Added
Info

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

2. Invoke data API to get the study data

Expand
titleClick to expand

Code Block
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"

In the above code, the 'GET' and 'Authorization' will remain fixed.

Code that will

...

vary

Token: #1step_token

...

token from #1 step

Server URL: https://qlhc2.build.openclinica.io

...

OC server URL

Study Name: S_ISPY(TEST)

...

study OID from the

...

OC.

After

...

Invoking data API, you will know how much time it takes to

...

download study data.

Image Modified

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