Fields in Remote Issue Links

Available:

JIRA 5.0 and later.

This page provides a guide to the fields used by the Remote Issue Link REST and Java APIs.

(tick) = required otherwise you can't create the link
(thumbs up) = we strongly recommend you pass in this value

See the REST API Guide for examples with full JSON sample data and screenshots.

Field

Required

JSON Key

Description

Impact if blank

GlobalID

(thumbs up)

globalId

A globally unique identifier which uniquely identifies the remote application and the remote object within the remote system. The maximum length is 255 characters.

You will not be able to update or delete the link unless you know the internal ID of the link

Relationship

relationship

Relationship between the remote object and the JIRA issue. This can be a verb or a noun. It is used to group together links in the UI.

"links to" used in UI

Object

URL

(tick)

object.url

A hyperlink to the object in the remote system.

N/A

Title

(tick)

object.title

The title of the remote object.

N/A

Summary

object.summary

Textual summary of the remote object.

No text in UI

Icon URL

(thumbs up)

object.icon.url16x16

A 16x16 icon representing the type of the object in the remote system.

Default link icon will be used in UI

Icon Title

(thumbs up)

object.icon.title

Text for the tooltip of the main icon describing the type of the object in the remote system. The Icon Title and Application Name are combined to form the tooltip.

Only Application Name is used in tooltip **

Resolved

object.status.resolved

Whether the remote object is "resolved" (value is "true") or "unresolved" (value is "false"). This value will only make sense where the remote object is something that is resolvable (eg. an issue, support ticket, etc). It will not make sense for things like wiki pages.
If Resolved is "true", the link to the issue will have a be in a strikethrough font.

Title text will appear in normal font in UI

Status Icon URL

object.status.icon.url16x16

A 16x16 icon representing the status of the remote object.

No status icon in UI

Status Icon Text

object.status.icon.title

Textual description of the status for the tooltip of the the status icon. Not used if Status Icon URL is blank.

Status icon doesn't have a tooltip

Status Icon Link

object.status.icon.link

A hyperlink for the tooltip of the the status icon. Not used if Status Icon URL is blank.

Status icon is not clickable

Application

Application Name

(thumbs up)

application.name

The human-readable name of the remote application instance that stores the remote object. Links are grouped on the Application Type and Application Name _in the UI. The _Icon Title and Application Name are combined to form the tooltip of the main icon. 

Only Icon Title is used in icon tooltip
**If Icon Title is also blank, icon tooltop is "Web Link" 
Grouping and sorting of links may place these links last

Application Type

(thumbs up)

application.type

The name-spaced type of the application. It is not displayed to the user. Renderering plugins can register to render a certain type of application. Links are grouped based on the Application Type and _Application Name _in the UI.
See sorting below.

You will not be able to provide a custom renderer for your links

Uniqueness on Global ID for a particular issue key, is enforced.

Field

Remote JIRA Example

GlobalID

appLinkId=123&issueId=123

Relationship

duplicates

URL

http://mycompany.com/jira/CWD-111

Title

CWD-111

Summary

Support nested groups

Icon URL

http://mycompany.com/jira/bug.png

Icon Title

Bug - A problem which impairs or prevents the functions of the product

Resolved

false

Status Icon URL

https://www.mycompany.com/jira/images/icons/newfeature.gif

Status Icon Text

Resolved – A resolution has been taken, and it is awaiting verification by reporter.  From here issues are either reopened, or are closed.

Application Name

My Company JIRA

Application Type

com.atlassian.jira

Field

Remote Confluence Example

GlobalID

appLinkId=456&pageId=123

Relationship

mentioned in

URL

http://www.website.com/hello.html

Title

My First Page

Icon URL

http://mycompany.com/wiki/page.png

Icon Title

Page

Status Icon Link

My Company Wiki

Application Type

com.atlassian.confluence

Field

Web Link Example

URL

http://www.website.com/hello.html

Title

Hello World

Was this page helpful?

Have a question about this article?

See questions about this article

Powered by Confluence and Scroll Viewport