Jazz Forum Welcome to the Jazz Community Forum Connect and collaborate with IBM Engineering experts and users

Will APIs used in Doors Next Generation 7.0.3 work in 7.0.2?

I am developing a widget for Doors Next and I am using the Reportable REST API and OSCL API. For the OSLC API I am specifically doing a query where I am retrieving artifacts within a specified module where a custom attribute has a specific value. For example, the query below is retrieving artifacts that are within the module 1294667, and they have a custom attribute named "pvVariants" that has the value "OPT1":

https://server?oslc.query=true&oslc_config.context=https://server/rm/cm/stream/_n6sXQITiEe-Km_7reoRTxw&oslc.prefix=oslc_rm=<http://open-services.net/ns/rm#>,dcterms=<http://purl.org/dc/terms/>,rp0=<https://server/rm/types/>&oslc.select=oslc_rm:uses{dcterms:title},oslc_rm:uses{dcterms:identifier}&oslc.where=dcterms:identifier=1294667 and oslc_rm:uses{rp0:AD_r9hZsIc2Ee-bY_dDub0TeA="Opt1"}

The current environment that I am testing in is Doors Next Generation 7.0.3, but there is another environment that my widget will get deployed to that is on Doors Next Generation 7.0.2. Can I be certain that the Reportable REST API will also work in 7.0.2? I didn't see anything in it's documentation that indicated that there was functionality that was only available in 7.0.3 and beyond. Can I also be certain that the OSLC API query that I am doing in 7.0.3, which involves using oslc_rm:uses in the oslc.select and oslc.where clauses like shown in the API call example above will work in 7.0.2?

0 votes

Comments

Basically yes except where an API or a feature of an API is described as e.g. 'new in 7.1', but as Ralph says you would be best to develop for the oldest version, e.g. 7.0.2 to ensure the functionality is good for 7.0.2, and forward port to newer versions.



So for the Reportable REST API I don't see anything in the documentation indicating that any functionality is specific to 7.0.3 and beyond, so I'm not too worried about that. However, do you know if there is documentation online somewhere for Doors Next that confirms that can use  the oslc_rm:uses in the oslc.select and oslc.where parameters in OSLC queries in 7.0.2 like I am doing in the example in my question? The only OSLC documentation I found for Doors Next is Using OSLC capabilities in the RM application. However, that documentation was last updated on 1/17/2013.

OSLC is an open standard that is documented someplace else. E.g. https://docs.oasis-open-projects.org/oslc-op/rm/v2.1/requirements-management-spec.html . Try to follow the public specification.

1 vote

Since OSLC is an open standard, if an OSLC query works in Doors Next 7.0.3, then in theory since Doors Next 7.0.2 also follows the OSLC standard the same query should also work in Doors Next 7.0.2?

AFAIK that's covered by my "basically yes" comment :-) But please try it to confirm.

1 vote


Accepted answer

Permanent link

Nothing in life is certain.

However, for supported APIs (can be found from https://jazz.net/wiki/bin/view/Deployment/ELMProductAPILanding) the goal is, to not break it. If there is a need to break it, it should be documented. You can see the changes over time for the Reportable REST API in the documentation. 

Usually, you would develop for the lowest version number and then see, if there is change in the API, which should be documented. 

Joshua Baxter selected this answer as the correct answer

0 votes

Your answer

Register or log in to post 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.

Search context
Follow this question

By Email: 

Once you sign in you will be able to subscribe for any updates here.

By RSS:

Answers
Answers and Comments
Question details
× 10,947

Question asked: Jan 13, 2:22 p.m.

Question was seen: 129 times

Last updated: Jan 15, 9:37 a.m.

Confirmation Cancel Confirm