Versions Compared

Key

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

...

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 the above code, the ‘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 OpenClinica 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.

  • The protocol decides what language should be used for communication between the client and the server.

  • The hostname decides where the server is placed.

  • 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.

  • The path decides the location of the resource on the host. When not specified, it is /

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.

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 Use the token from #1 step

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

Study Name: S_ISPY(TEST) will be the study OID from the OpenClinica

...

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

...