It's all about the answers!

Ask a question

Access DOORS NG cloud trial through REST API


Stanley Hillner (132) | asked Oct 12 '18, 5:07 a.m.
Hello together,

I've just registered for the cloud trial period and wanted to evaluate the DOORS NG REST API access capabilities for a customer project. I'm currently stuck at the point that I'm not able to figure out the correct REST endpoint URL under which I can access my project.
Is there a link or button that gives me the API endpoint URLs or is there a scheme of how to build these URLs?

Thanks in advance!

Accepted answer


permanent link
Ralph Schoon (62.9k33645) | answered Oct 17 '18, 3:14 a.m.
FORUM ADMINISTRATOR / FORUM MODERATOR / JAZZ DEVELOPER
edited Oct 17 '18, 3:53 a.m.

 Please see https://jazz.net/library/article/1197 . You should be able to access the rootservices document e.g. https://clm.example.com:9443/rm/rootservices from there you can find the service provider catalog https://clm.example.com:9443/rm/oslc_rm/catalog and there the service provides (for the project ares). 


https://github.com/eclipse/lyo.client provides a way to use Java and an example to access RM.

Stanley Hillner selected this answer as the correct answer

Comments
Stanley Hillner commented Oct 17 '18, 5:55 a.m.
Thanks I'll have a look into these resources.

One other answer



permanent link
Bas Bekker (1.4k4) | answered Oct 17 '18, 12:19 p.m.
JAZZ DEVELOPER
edited Oct 17 '18, 12:31 p.m.

For completeness, the DNG public API's that are available are:

  • OSLC RM V2 API - the open standard way to programmatically integrate with DOORS Next Generation, there is an elaborate workshop to get you started here OSLC Workshop article. These programs can be from any language that support HTTP REST calls, e.g. Java, C# etc. Hence these are more flexible to run and can read and update DNG data, as part of a web server, or standalone, but have some limitations set by the current OSLC standard, for example module support. In release 6.0.5 extension have been added for modules.
  • DNG Server API - starting with version 6.x, various public RM server API's have been added, for configuration management, task tracker, modules, ReqIF, and type import.
  • TRS 2.0 - the OSLC Tracked Resource Set open standard REST API to hook into the stream of low level changes done to resources in the DNG application (and other Jazz apps as well); read only.
  • and as mentioned above, there is the client extension capability, these are Javascript extension that generally added as widgets you can run from the dashboard, and can be used to view and edit DNG data. It's more tailored to DNG, so has better module support, but is limited to run in a browser/javascript environment.

And there is the private REST API, which you could reverse engineer looking at the requests/responses, but it isn't documented and supported, and can change over time, so usage at your own risk.

Your answer


Register or to post your answer.