Understanding OSLC Connect for Jira Link Storage

The following section describes how we store OSLC links in OSLC Connect for Jira. The intention is to provide support for those writing automation and migration scripts. We caution all users creating such applications. We do not directly support modification of this data and suggest both caution (careful review) and care (backups!) when working with this data.

The OSLC Links are stored as general Jira Remote Links. This allows us to use the common extension and management mechanisms. Remote links intend to enable the connection to external tools as we do in OSLC.

Note that some links do require backlinks stored in the remote tool (for example, Polarion). The storage of these links is the responsibility of the remote tool. Updating a Jira Remote link only addresses the storage in Jira and not the remote endpoint.

Accessible through REST API

Remote links are accessible via Jira REST APIs. More details can be found → https://developer.atlassian.com/server/jira/platform/jira-rest-api-for-remote-issue-links/

This API allows creating, updating, and deleting remote links, including our OSLC links.

Structure of an OSLC Link

A sample OSLC link stored as a remote link appears like the following.

JSON

	{
		"id": 10203,
		"self": "https://phoenix-jira.sodiuswillert.cloud/rest/api/latest/issue/AMRPRT-1/remotelink/10203",
		"application": {
			"type": "com.sodius.oslc.app.jira",
			"name": "Collaboration Link"
		},
		"relationship": "implements requirement",
		"object": {
			"url": "https://portland-elm.sodius.cloud/rm/resources/BI_z2FR85hjEe6TI5H6Q2kosw",
			"title": "670: All exposed equipment shall have an operating temperature range of -4° to 122° F/-20° to 50° C. (In Module: Requirements for Reuse)",
			"icon": {},
			"status": {
				"icon": {}
			}
		}
	},

The application type and name to be set as above to enable the behaviors of OSLC to be applied. Without the application being identified as com.sodius.oslc.app.jira there will be no updates of the resources, rich hovers, or icon updates.

The relationship is the role of the OSLC link. These are the standard OSLC names and are expressed in all lowercase. This is both for the relationship binding as well as the visual grouping of the links in the link view in Jira.

The URL is the remote resource location for storage in the remote tool. This will vary from tool to tool. Some tools have a standard structure using simple keys, and some, like DNG, have a more elaborate encoding.

The title is the remote artifact title. If you use the private linking mode the remote title will be stored as “com.sodius.oslc.security.privateLinking”.

Dynamics of an OSLC Link

The application fully addresses the dynamic behavior you observe on the OSLC link. The updates after authentication are only used in the session by the UX and are not triggering updates to the Remote Link.