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

DNG : Given a Global Baseline, how to fetch all the DNG modules programmatically ?

Questions
Tags
Users
Badges
Shwetha G
(29●25●26●27) Feb 11 '25, 6:15 a.m.

Hi Team,


I have a usecase wherein given a DNG global baseline or a Stream, i need to fetch all the DNG modules below it programmatically. Is it possible ? 
It is fine if it is an API as well, I can parse the response and get the required details. Please suggest. Thanks.

0 votes

4 answers
2,912 views
0 votes

4 answers

Permanent link
Ralph Schoon
FORUM ADMINISTRATOR / FORUM MODERATOR / JAZZ DEVELOPER (64.6k●3●36●49) Feb 11 '25, 11:00 a.m.

You can find the public APIs here: https://jazz.net/wiki/bin/view/Deployment/ELMProductAPILanding this includes the DNG APIs. 
We did some work in the past here the article series and source code that works on configurations: https://jazz.net/library/article/92596 also this blog here https://rsjazz.wordpress.com/2019/03/07/type-system-manager-part-2/

1 vote

Permanent link
Ian Barnard
FORUM ADMINISTRATOR / FORUM MODERATOR / JAZZ DEVELOPER (3.0k●7●15) edited
Feb 11 '25, 12:06 p.m.

OSLC Query is one way - query for modules using oslc.where=rdf:type=oslc_rm:RequirementCollection (where the bold part has to be url-encoded because it's a parameter value) - see https://docs.oasis-open-projects.org/oslc-op/query/v3.0/oslc-query.html - this article gives a brief overview of the OSLC APIs https://jazz.net/library/article/1197


Once you've got the query results you can use then module URLs to get more details with a further OSLC Query, for example to get all the used artifacts, or use the OSLC RM API to GET the details of the module, or the Module Structure API to retrieve the hierarchy in the module, see https://jazz.net/wiki/bin/view/Main/DNGModuleAPI

Or the Reportable REST API may be able to return all modules in a GC - see https://jazz.net/wiki/bin/view/Main/DNGReportableRestAPI

1 vote

Comments
Shwetha G
Feb 12 '25, 1:26 a.m.
this page has the required API to get the Modules from the GC Baseline : https://jazz.net/rm/doc/scenario?id=GetFlatListOfContributionsForGcHiearchy However can we also get the Modules from the GC Stream ?   Thanks for this response Ralph and Ian.

Ian Barnard
FORUM ADMINISTRATOR / FORUM MODERATOR / JAZZ DEVELOPER Feb 12 '25, 5:11 a.m.
That API gives you only the contribution (configuration) URLs for the GC configuration - nothing to do with modules. The contribution URLS might be useful if you wanted to later use the specific local configurations in a query, but you can directly use the GC configuration URL with OSLC Query to get modules in that GC configuration. Be aware that if you wanted for example to query for a specific type of module, the URL for that type of URL is configuration-specific so inevitably you will only get results from the component where that type of module is defined in the typesystem. But a more general query like oslc.where=rdf:type=oslc_rm:RequirementCollection will return modules anywhere in RM contributions to the GC.

1 vote

Permanent link
Shwetha G
(29●25●26●27) Feb 12 '25, 6:38 a.m.

thanks Ian,


This API gets a flat list of GC hierarchy, how can i get this for a hierarchical structures of the GC Streams ?

0 votes

Comments
Ian Barnard
FORUM ADMINISTRATOR / FORUM MODERATOR / JAZZ DEVELOPER Feb 12 '25, 7:25 a.m.
The GC APIs are shown here https://jazz.net/gc/doc/scenarios

1 vote

Permanent link
Shwetha G
(29●25●26●27) Feb 17 '25, 6:38 a.m.

This API list doesnt have the details of getting the Modules from the Stream. Is it possible to get the modules from the Stream ?

0 votes

Comments
Ian Barnard
FORUM ADMINISTRATOR / FORUM MODERATOR / JAZZ DEVELOPER Feb 17 '25, 6:50 a.m.
Refer to my answer https://jazz.net/forum/answer_link/290470/

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.

Ask a question
Guidelines
FAQ
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
× 11,106

Question asked: Feb 11 '25, 6:15 a.m.

Question was seen: 2,912 times

Last updated: Feb 17 '25, 6:50 a.m.

Confirmation Cancel Confirm