RM API for RDNG
Hello!
Is it possible to get acquainted with RM API in detail when developing custom extensions for Rational DOORS Next Generation? I can find in samples of extensions various predefined attributes:
RM.Data.Attributes.NAME,
RM.Data.Attributes.IDENTIFIER,
RM.Data.Attributes.IS_HEADING,
RM.Data.Attributes.SECTION_NUMBER,
RM.Data.Attributes.DEPTH,
But is it possible to get full list of such attributes and may be something else in a way as most of API descriptions can inform? For example, I would like to use such data of a single artifact as itemId, about, etc. Is it possible to see some API where I could find all required info without need to learn scattered samples?
Thank you!
|
Accepted answer
Hello Dimitry,
Most APIs for Jazz-based products follow the OSLC specification. Usually, you start at an application's root context to get the top-level services (APIs) for an application like DNG. Identify the service you need, then request further services using that URL. It's common to drill down on a number of services to get the specific one you might need.
For example, if you're looking for what role a team member is assigned to, you'd get the top-level service for project collections, and use that to get the service for a specific project. In that service you can get the team member collection service, and from that get the service for a specific team member. In that service, you can get the role service which will provide a list of roles for that specific user.
You can find these services to looking at the wiki pages accessible from the API landing page I sent you. Or you can manually query for the services you need by drilling down on them using a tool like Postman.
The OSLC Workshop makes this pattern clearer and provides steps for accessing OSLC services as described above.
Dmitry A. Lesin selected this answer as the correct answer
Comments
Dmitry A. Lesin
commented Nov 14 '18, 6:25 a.m.
Hello Jim,
Thank you! I didn't know that workshop for RM was added like workshop for CCM.
Thank you a lot!
Dmitry A. Lesin
commented Nov 14 '18, 6:25 a.m.
Hello Jim,
Thank you! I didn't know that workshop for RM was added like workshop for CCM.
Thank you a lot!
|
3 other answers
Hello, have you reviewed this document? It provides some info about RM classes.
Comments
Dmitry A. Lesin
commented Nov 10 '18, 2:55 a.m.
Yes, thank you! I'm using this article developing extensions. For example, I can find description of some classes and methods here, like "RM.Data.getAttributes" class and others. But the problem is that I would like to find description (or at least sources, where these classes are realized) for "RM.Data.Attributes" (and other classes) to quickly develop really powerful extensions.
For example, I need currently to find itemId of a selected artifact in a module. I don't know, whether such attribute is defined in "RM.Data.getAttributes", or I can only get this value with HTTP request with Reportable API based on ID of this data. The second way is much more difficult. But there's a hope that I could get it faster if I would get acquanted with description of RM API (or with sources with realized classes of RM API).
Thank you!
|
To expand a bit on Jim's answer above, the full set of available DNG public API's are:
Comments
Dmitry A. Lesin
commented Nov 14 '18, 6:27 a.m.
Thank you!
It's really a helpful list of links for my use and for somebody's one else working with it.
|
Your answer
Dashboards and work items are no longer publicly available, so some links may be invalid. We now provide similar information through other means. Learn more here.
Comments
I found this library: