Welcome to the Jazz Community Forum
Where to find Diagram artifact information using the RRC Reportable REST API?
Hello All,
With Rational RM/DNG 6.0, there is a new artifact type called "Diagram". We have created Diagram artifacts in DNG and want to display them on our reports using RPE.
How do we use the RRC Reportable REST API to display "Diagram" artifact types? Specifically, where is Diagram type information located in the schema? What should the query URL look like?
We have tried looking under all the existing artifact types (usecasediagrams/sketches/etc) according to the REST API documentation, but I am not able to find Diagrams anywhere.
Is there updated documentation for the DNG REST API for 6.0 that can tell me how to pull the Diagram information?
Here is the REST API documentation I have looked at with no luck so far.
Thanks for any help!
Accepted answer
Hi Allen,
'Diagram' artifact format does not have a Reportable API representation. This also happened with Parts that you should include into an Sketch and use the 'uisketches' schema to retrieve the information. So as for 'Diagram' artifacts, you can embed it into a text-based artifact and retrieve the information using 'text' schema:
https://server:port/rm/publish/text?resourceUri=artifact_uuid
Where:
artifact_uuid is the identifier of the artifact that contains the 'Diagram' artifact embedded.
This is an example of the Reportable API output using 'text' schema:
In bold is the reference to the graphical representation of the 'Diagram' artifact.
Hope that helps
'Diagram' artifact format does not have a Reportable API representation. This also happened with Parts that you should include into an Sketch and use the 'uisketches' schema to retrieve the information. So as for 'Diagram' artifacts, you can embed it into a text-based artifact and retrieve the information using 'text' schema:
https://server:port/rm/publish/text?resourceUri=artifact_uuid
Where:
artifact_uuid is the identifier of the artifact that contains the 'Diagram' artifact embedded.
This is an example of the Reportable API output using 'text' schema:
In bold is the reference to the graphical representation of the 'Diagram' artifact.
Hope that helps