Quick Links
Categories
- 4.2K All Categories
- 272 Discussions
- 172 General Discussion
- 20 Roadmap & New Feature Ideas
- 28 Add-Ons & Code Contributions
- 52 Forum How-Tos
- 996 Q & A
- 215 Installation & Setup
- 381 Study Build, Rules, and CRFs
- 138 Data Entry, Monitoring, and Data Management
- 113 Extracting & Reporting
- 11 Regulatory Compliance
- 35 Rule Designer
- 92 Web Services & Integration
- 11 Internationalization and Localization (i18n / L10n)
- 23 Announcements & Updates
- 23 Announcements & Updates
- 4.8K Archives
- 3K Users Mailing List
- 1.8K Developer Mailing List
We hope you'll join us for our 4/23 webinar on using data tables to apply reference ranges and AE codes in OC4. For more information and to register, visit https://register.gotowebinar.com/register/2882170018956684555
API Documentation
medonja
Posts: 5 ✭
I am wondering how accurate and up-to-date the REST API Documentation at https://dev.openclinica.com/apidoc/ is?
I have tried to call the /pages/odmk/studies/S_DEFAULTS1/metadata endpoint as described in the documentation in order to retrieve the default study's metadata, however, all I get is an empty 200 response. Then again, this page https://docs.openclinica.com/3.1/technical-documents/rest-api-specifications/read-openclinica-odm-metadata-rest-service mentions the somewhat different endpoint pages/rule/studies/S_DEFAULTS1/metadata, which is, I believe, returning the same data the endpoint from the API documentation intended to provide.
I am using OpenClinica Community Edition 3.13.
Can someone more experienced with consuming the API elaborate a bit about the difficulties and obstackles that one could encounter when writing a REST client for OpenClinica?
I have tried to call the /pages/odmk/studies/S_DEFAULTS1/metadata endpoint as described in the documentation in order to retrieve the default study's metadata, however, all I get is an empty 200 response. Then again, this page https://docs.openclinica.com/3.1/technical-documents/rest-api-specifications/read-openclinica-odm-metadata-rest-service mentions the somewhat different endpoint pages/rule/studies/S_DEFAULTS1/metadata, which is, I believe, returning the same data the endpoint from the API documentation intended to provide.
I am using OpenClinica Community Edition 3.13.
Can someone more experienced with consuming the API elaborate a bit about the difficulties and obstackles that one could encounter when writing a REST client for OpenClinica?
0
Comments
I think the end-point documentation you mention is for oc4 only.
With oc313 you should be able to use
/rest/metadata/xml/view/S_DEFAULTS1
Kind regards,
Gerben Rienk
thanks for the reply, I will try to go with this endpoint
However, I feel a bit frustrated, since I have nowhere seen this endpoint before. Is there perhaps some comprehensive documentation for oc313 available online?
Best regards,
Marko