It's all about the answers!

Ask a question
QuestionsTagsUsersBadges
Guidelines | FAQ
Follow this question
Question details

×5,944
×1,441

question asked: Oct 17, 6:29 p.m.
question was seen: 272 times
last updated: Oct 28, 1:55 p.m.

Related questions

DOORS Next Generation 7.0.3: Pull multiple change set details in a single API call

0
Joshua Baxter (51●2●7●15) | asked Oct 17, 6:29 p.m.

I found a Change Set API for pulling the actual changes contained in a change set here: https://jazz.net/wiki/bin/view/Main/DNGChangesetContentsApiOverview#Changeset_Contents_Delivered_or. However ideally for performance reasons I would like to request the change set details for multiple change sets in a single API call given I have the change set IDs. However this API doesn't indicate that it supports that. Is it possible to request multiple change set changes in a single API call?



 

Accepted answer

1
permanent link
Ian Barnard (2.3k●7●14) | answered Oct 18, 3:43 a.m.
FORUM ADMINISTRATOR / FORUM MODERATOR / JAZZ DEVELOPER
edited Oct 18, 3:44 a.m.

That api is new in 7.1.


The API returns content of a single changeset.

Joshua Baxter selected this answer as the correct answer
Comments
Joshua Baxter commented Oct 21, 3:20 p.m. | edited Oct 21, 3:28 p.m.

Thanks for confirming. I'm able to call the Change Set API at http://server/rm/cm/changeset/_ID, where ID is the ID of the change set. While I did get a result back there was no dng_config_changes XML element in the response. I tried calling http://server/rm/cm/changeset/_ID/changes in order to get the change set content details, and got a "Could not retrieve IConfigurationDetails for URI" response with a 404 error. How do I get the change set content details via the API in DNG 7.0.3? I'm not understanding what I'm doing wrong.

Ian Barnard commented Oct 22, 3:40 a.m.
FORUM ADMINISTRATOR / FORUM MODERATOR / JAZZ DEVELOPER

The documentation says "In DN 7.1 a new public REST API was introduced..."


As you're not using 7.1 you won't be able to access changeset details.

Joshua Baxter commented Oct 22, 8:37 a.m.

Thanks for your quick response. In the documentation in the sample response given, it has <dng_config:Addition> and <dng_config:Deletion> XML elements which then have a <dng_config:concept> XML element that has a URL. I'm assuming that URL would be another API call to view the actual changes? Is it documented somewhere what the schema for the API call made for that would return, or at least sample data showing what that would return? That way we could at least anticipate what types of details we would be able to retrieve once we get DNG 7.1.

Ian Barnard commented Oct 23, 3:33 a.m. | edited Oct 23, 3:34 a.m.
FORUM ADMINISTRATOR / FORUM MODERATOR / JAZZ DEVELOPER

If you read the documentation (which is an overview page) there's a link to DOORS Next Changeset Contents Resources 1.0 which gives details of the schema

Joshua Baxter commented Oct 23, 9:01 a.m. | edited Oct 23, 9:08 a.m.

Thanks for your response, I appreciate your help. Maybe I'm missing something but in the DOORS Next Changeset Contents Resources 1.0 documentation it just says that the dng_config:concept element "Specifies the concept URI of a resource changed in the changeset". I don't see where it specifies what the schema would be when calling that URI in an API call, it just says that it returns an rdf:resource (please see screenshot below).

Ralph Schoon commented Oct 23, 10:34 a.m.
FORUM ADMINISTRATOR / FORUM MODERATOR / JAZZ DEVELOPER

These API are all RDF based. When it wants the information from the highlighted line an prefixed resource: dng_config:concept and rdf:resource it wants the something like:
[dng_config:concept rdf:resource="https://clm.example.com:9443/some/uri/to/something"/]. Note, I used [] brackets, because the editor is not so good with XML. Replace [ by <. 

I have tried to explain a bit here. https://jazz.net/library/article/92596 Try to read an element first, then you have a better idea.

Ralph Schoon commented Oct 23, 10:40 a.m.
FORUM ADMINISTRATOR / FORUM MODERATOR / JAZZ DEVELOPER

The concept URI is an rdf:resource that is describing the requirements resource element. All versions in the system based on this item, reference it. It is the anchor that is represents that bare bones element.  

Ralph Schoon commented Oct 23, 10:47 a.m.
FORUM ADMINISTRATOR / FORUM MODERATOR / JAZZ DEVELOPER

OSLC RM, which is very similar is explained here: https://docs.oasis-open-projects.org/oslc-op/rm/v2.1/requirements-management-spec.html.

I don't like RDF so much, I prefer the Turtle representation over RDF. The information is the same, but Turtle is clearer to me. There are converter available online. See: https://www.google.com/search?q=rdf+to+turtle+online

Joshua Baxter commented Oct 23, 12:27 p.m.

Thanks for your response and patience. The  https://docs.oasis-open-projects.org/oslc-op/rm/v2.1/requirements-management-spec.html. link doesn't work for me, I get a 404 error. 

Sorry if my questions seem ignorant, this is all new to me. I was under the impression that calling the URL in rdf:resource elements in an API call would give me data that was specific to the API, and that it would have specific unique elements in the response. For example, return the actual details pertaining to the the changes made in the change set (For example: API call tell return XML telling me specifically what was added). Based on your response it seems like the API will just return a generic rdf:resource, which if I call via API will only return data in the rdf:resource schema? Where is the rdf:resource schema documented?

Joshua Baxter commented Oct 28, 1:55 p.m.

Hey Ralph. Did you get a chance to read my comment above?

showing 5 of 10 show 5 more comments

Your answer

Register or 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.