RRC+RPE: ReportableAPI using usecasediagrams is empty for diagrams included in modules
We use modules to build up a customer targeted document. That module includes artifacts of type "Use Case Diagram".
To retrieve all elements of the module we use the URL:
https://inst01.rth-de.ihost.com/rm/publish/resources?moduleURI=_QD5nUy8fEeORe99oaVdJLw&showEmbedTitles=true
The result contains what we expected. The artifacts "use case diagrams" are included, but we want to get the specific content for the use case diagrams, therefore use the "itemId" from the result and use that one for querying.
https://inst01.rth-de.ihost.com/rm/publish/usecasediagrams?resourceURI=_e54eafab4efa4333a3520acb21a2a79f
Unfortunately, the result is empty.
What are we doing wrong on this?
To retrieve all elements of the module we use the URL:
https://inst01.rth-de.ihost.com/rm/publish/resources?moduleURI=_QD5nUy8fEeORe99oaVdJLw&showEmbedTitles=true
The result contains what we expected. The artifacts "use case diagrams" are included, but we want to get the specific content for the use case diagrams, therefore use the "itemId" from the result and use that one for querying.
https://inst01.rth-de.ihost.com/rm/publish/usecasediagrams?resourceURI=_e54eafab4efa4333a3520acb21a2a79f
Unfortunately, the result is empty.
What are we doing wrong on this?
One answer
This is expected result.
To get information about an artifact, we need to query using the base artifact UUID.
If we use the "binding" URL (i.e. _e54eafab4efa4333a3520acb21a2a79f ), then it is normal that there is nothing returned.
I think the problem here is that when we try to get the module's information via REST API, it doesn't conveniently return the base artifact UUID for you to query on.
I believe that this is handled by this defect:
Module context binding stores wrong "about" URI for use case diagram (84835)
Will be fixed in 5.0
At this moment, if you search the artifact id and get that specific usecase diagram, from the chain icon, you would see the UUID is different from the one you got, that one should be the base artifact UUID.
Hopefully this helps.
To get information about an artifact, we need to query using the base artifact UUID.
If we use the "binding" URL (i.e. _e54eafab4efa4333a3520acb21a2a79f ), then it is normal that there is nothing returned.
I think the problem here is that when we try to get the module's information via REST API, it doesn't conveniently return the base artifact UUID for you to query on.
I believe that this is handled by this defect:
Module context binding stores wrong "about" URI for use case diagram (84835)
Will be fixed in 5.0
At this moment, if you search the artifact id and get that specific usecase diagram, from the chain icon, you would see the UUID is different from the one you got, that one should be the base artifact UUID.
Hopefully this helps.
Comments
Just to clarify, the issue is with the "reportable" REST API, which has the base URL https://<host:port>/rm/publish/. The general REST API will correctly expose the boundArtifact, such as
https://inst01.rth-de.ihost.com/rm/resources/_e54eafab4efa4333a3520acb21a2a79f?accept=*&private=true