How get link types from RDNG

Dmitry A. Lesin

(248●2●69●96) edited

Aug 21 '19, 10:54 a.m.

Hello!

I need to get information about available link types in a project area. Using next link:

https://jazz.net/wiki/bin/view/Main/DNGReportableRestAPI

I can find that next REST API request is legal:

https://win2012:9443/rm/publish/linktypes

But server response to this link is:

Error 400: Bad Request

If I try use something like next:

https://win2012:9443/rm/publish/linktypes?projectURI=_0lYNsL9zEempFLODRb8LwA

Then returned empty XML document:

<ds:dataSource xmlns:ds="http://jazz.net/xmlns/alm/rm/datasource/v0.1" xmlns:rm="http://www.ibm.com/xmlns/rdm/rdf/" xmlns:rrm="http://www.ibm.com/xmlns/rrm/1.0/" appId="RRC" vMajor="60" vMinor="06"/>

So the question is, how can be loaded information about available link types for a project area with either REST or OSLC API?

Thank you!

0 votes

2 answers

3,486 views

0 votes

2 answers

Permanent link

Ivan Bravo

JAZZ DEVELOPER (176●2) Aug 21 '19, 11:58 a.m.

Hi Dmitry

As mentioned in Reportable API Wiki https://jazz.net/wiki/bin/view/Main/DNGReportableRestAPI, REST API request https://serverName:Port/rm/publish/linktypes is used by ETL, that means that it will provide link types only for "opt out" (configuration management disabled) project areas.

If there is no "opt out" project areas in the server, then it is expected an empty XML document, same is expected when using parameter "projectURI" and the project area provided has configuration management enabled.

Unfortunately I don't know any other way to get project link types.

0 votes

Comments

Dmitry A. Lesin

Aug 21 '19, 12:20 p.m.

Hi Ivan,

Thank you for the information. I appreciate it so much.

You are right at all. My project area is under configuration management. and we need to create links in a change set. This is a customer's prerequisite for an extension being developed.

It seems that I found some another way how to get this data. I have found that in OSLC project area services (services.xml), in " <oslc:creationFactory>" group, there's some record like next:

<oslc:resourceShape rdf:resource="https://win2012:9443/rm/types/__8blrr9zEempFLODRb8LwA"/>

This URI being GET returns a response that contains all descriptions of link types. But the problem is that there's a lot of such records there. And now the problem is how define a correct record with link types in advance. I think it's not a good way to request all similar records and try to define the correct one.

Don't you know how we can do it? I believe that it can solve the current problem, at least in a theory.

Thank you!

Permanent link

Brian Lahaie

(108●15●14) edited

Mar 15 '23, 11:08 p.m.

In a CM enabled environment I was able to do the following:

GET the services.xml file using this URL:

https://<hostname>:<port>/rm/oslc_rm/<PROJECT_AREA_UUID>/services.xml?oslc_config.context=https://<hostname>:<port>/rm/cm/stream/<STREAM_UUID>

    Headers:
   Accept = application/rdf+xml
    OSLC-Core-Version = 2.0

In the response from the GET request was the URLs for the types.

I then took this URL and did the following GET:

   Headers:
   Accept = application/rdf+xml
    OSLC-Core-Version = 2.0
    URL:   https://<hostname>:<port>/rm/types/OT_xvyTcYuLEe2Bk9tMZMvU5Q?oslc_config.context=https://<hostname>:<port>/rm/cm/stream/<STREAM_UUID>

0 votes

Comments

David Honey

FORUM ADMINISTRATOR / FORUM MODERATOR / JAZZ DEVELOPER Mar 16 '23, 5:40 a.m.

Clients should never hard code or make assumptions about URI patterns. If you want to know the URI of an OSLC service provider, use OSLC discovery.

Looking at the OSLC service provider of a CM enabled project area, I see OSLC query capabilities for RDF types http://jazz.net/ns/rm/dng/view#View, http://jazz.net/ns/rm/dng/reqif#ReqIFDefinition, http://jazz.net/ns/rm/navigation#folder, [http://open-services.net/ns/rm#RequirementCollection,http://open-services.net/ns/rm#Requirement], but nothing for type definition artifacts such as link types.

The ELM API landing page is at https://jazz.net/wiki/bin/view/Deployment/CLMProductAPILanding.I see nothing there that describes how to query for resources. So, it looks like the API endpoint that Brian mentioned should be treated as private, undocumented, and unsupported. Use of private APIs is discouraged because such APIs are subject to change without notice, making for potentially fragile implementations, and are unsupported.

Ian Barnard

FORUM ADMINISTRATOR / FORUM MODERATOR / JAZZ DEVELOPER Mar 16 '23, 7:48 a.m.

In each shape the link types can be identified as the tags that contain a tag:

<oslc:valueType rdf:resource="http://open-services.net/ns/core#Resource"/>

At least for DN all the link types appear to be repeated in all the shapes, so it's possible that just retrieving the first shape will get you all the link types. Not sure about this. Anyway these only change when a new link type is created, so maybe you could use e.g. http caching so re-retrieving doesn't require a GET to the server, or your app saves them and only refresh when user chooses or (perhaps) 7 days since last retrieved.

Before anyone asks about link constraints, AFAIK these aren't exposed in any public API https://jazz.net/wiki/bin/view/Deployment/CLMProductAPILanding

Ian Barnard

FORUM ADMINISTRATOR / FORUM MODERATOR / JAZZ DEVELOPER Mar 16 '23, 9:37 a.m.

GCM has similar tags in properties its shapes to denote link types - although it also has the benefit of a (OSLC) QueryCapability for link types :-)

Ian Barnard

FORUM ADMINISTRATOR / FORUM MODERATOR / JAZZ DEVELOPER Mar 16 '23, 9:40 a.m.

I agree with David about it being not a good approach to hardcode URL patterns, instead to use discovery. In this case for DN the link types can be discovered from the shapes, all accessible using OSLC-Core-Version: 2.0 and with no indication that this is a private API.

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.

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

extending

× 10,953

rational-doors-next

× 5,992

oslc

× 516

rest-api

× 481

links

× 92

Question asked: Aug 21 '19, 10:50 a.m.

Question was seen: 3,486 times

Last updated: Mar 16 '23, 9:40 a.m.

How get link types from RDNG

2 answers

3,486 views

0 votes

2 answers

Comments

Comments

Your answer

Follow this question

Question details

Related questions