REST API for the Rational Requirements Composer
We would like to be able to access artifacts stored in a requirements oroject in RRC 3.0.1. Although there apparently is no published REST API, I thought that I would try the same approach that is described for RTC:
I started with: https://<hostname>:9443/rm/rootservices and tried to navigate to the service descriptor for a reqiuirements project. However, I found that unlike the ccm case, very little information is actually available through this API for requirements projects. In contrast, I notice that an SDK was available for release 2: https://jazz.net/wiki/bin/view/Main/RationalRequirementsComposer2SampleCode Will this get updated for 3.0.1 ? Thanks |
21 answers
We would like to be able to access artifacts stored in a requirements oroject in RRC 3.0.1. Although there apparently is no published REST API, I thought that I would try the same approach that is described for RTC: Rational Team Concert has been in development for a few releases more than Requirements Composer and their API is at a point where it has/can be published. While we would like to do the same for Composer in a future release we need to make sure we do so at a time where it will be mature enough to not cause major impact due to resource dependencies. The RRC 3.0.1 release was another major shift from thick client to Web client so the architecture was still under significant change. |
We would like to be able to access artifacts stored in a requirements oroject in RRC 3.0.1. Although there apparently is no published REST API, I thought that I would try the same approach that is described for RTC: Rational Team Concert has been in development for a few releases more than Requirements Composer and their API is at a point where it has/can be published. While we would like to do the same for Composer in a future release we need to make sure we do so at a time where it will be mature enough to not cause major impact due to resource dependencies. The RRC 3.0.1 release was another major shift from thick client to Web client so the architecture was still under significant change. Is ithis information now published? I want to write a small program to import form XML file. |
did you check if the OSLC RM API could help you, e.g. using the RRC CreationFactories ?
http://open-services.net/bin/view/Main/RmSpecificationV2?sortcol=table;table=up#Creation_Factories One thing that is important is to send the custom HTTP header OSLC-Core-Version="2.0" (as described here: http://open-services.net/bin/view/Main/OslcCoreSpecification?sortcol=table;up=#Specification_Versioning) with your HTTP requests, otherwise you will get back "legacy" service descriptor resources and won't see the new OSLC v2 capabilities... |
We are currently working on an update to the existing OSLC workshop on Jazz.net which will include samples and other introduction material for OSLC-RM v2.
Stay tuned. Watch for updates to this article in Jazz.net library: https://jazz.net/library/article/635 did you check if the OSLC RM API could help you, e.g. using the RRC CreationFactories ? |
We are currently working on an update to the existing OSLC workshop on Jazz.net which will include samples and other introduction material for OSLC-RM v2. did you check if the OSLC RM API could help you, e.g. using the RRC CreationFactories ? Will this be available with 3.0.1.1 of RRC? As I see |
|
The updates we are working on use RRC 3.0.1 which is OSLC-RM API v2 compliant from an implementation point of view.
We are currently working on an update to the existing OSLC workshop on Jazz.net which will include samples and other introduction material for OSLC-RM v2. did you check if the OSLC RM API could help you, e.g. using the RRC CreationFactories ? Will this be available with 3.0.1.1 of RRC? As I see |
Are links (between requirements and/or other artifacts) exposed and POSTable with the OSLC interface? I've got the following in the XML for a requirement which has links to other requirements:
but I can't seem to figure out where those links are exposed? |
|
Only specific oslc relationships/links are exposed via the API.
See Relationship properties on this page in the specification: http://open-services.net/bin/view/Main/RmSpecificationV2?sortcol=table;table=up#Resource_Requirement Are links (between requirements and/or other artifacts) exposed and POSTable with the OSLC interface? I've got the following in the XML for a requirement which has links to other requirements: |
|
Thanks Rosa.
So none of the "inter-requirement" links from the OOTB templates (eg. Child of, Embeds, Link To, Illustrated By, Satisfied By, Constrained by) are exposed :-( And I can't seem to use the "OSLC Affected By, OSLC Elaborated By and OSLC Specified by" link types, at least in the JKE Banking or the Use Case template. Freddy |
After reading this post I'm still confused about the outcome so far.
There seems to be suggestions here that it currently is, or could be, possible to access RRC via a REST API such as OSLC RM (for RRC 3.0.1). Though, like others say, I also find that there simply aren't enough services in the RM discovery to support this. Can someone give a black and white answer as to whether the OSLC RM API works (or not) in RRC 3.0.1? When I access my rootservices for RM I get a catalog for: https://localhost:9443/rm/discovery/RMCatalog For my sole ServiceProvider I get a services resource of: https://localhost:9443/rm/discovery/_xp0_cN24EeC5dZI2YAS1KA/services.xml When I drill into this, I get 3 high level services of:
oslc_rm:collections oslc_rm:links The total services available within all of these is:
oslc_rm:CollectionSelectionDialog oslc_rm:LinkCreationServices None of these seem to be creation factories or query services that would allow me to GET or POST/PUT requirements. |
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.