How to list the globalId to use in issuesWithRemoteLinksByGlobalId("") JQL function?

Hi,

I was not able to find the in the documentation for "globalId" definition and how to get it on the server.

Could you please help to find the documentation for it?
I would like to try out the built-in JQL function "issuesWithRemoteLinksByGlobalId()" to list issues linked with pages towards our Confluence server.

The only documentation what is touching the topic:
https://developer.atlassian.com/jiradev/jira-platform/guides/other/guide-jira-remote-issue-links/fields-in-remote-issue-links

Kind regards,

Béla

3 answers

Late to the party here, but I had to learn this trick today and thought I'd share my results, since it isn't well-documented.

These steps will seem a bit backwards, but bear with me. For this example I'm assuming you're using cloud Jira and Confluence, so your applications are hosted at https://example.atlassian.net/. 

  1. Assuming you know that a particular Confluence page contains a link to a Jira ticket called EXAMPLE-1234, you can query the Confluence REST API for all mentions of that Jira ticket with: https://example.atlassian.net/rest/api/latest/issue/EXAMPLE-1234/remotelink. This API request says, "show me all the external integrations that link to EXAMPLE-1234".
  2. The above API request will return a JSON blob listing every external integration where the ticket EXAMPLE-1234 is linked. For example:
    {
    "id": 55555,
    "self": "https://example.atlassian.net/rest/api/latest/issue/EXAMPLE-1234/remotelink/55555",
    "globalId": "appId=abc-123-cde-456&pageId=987654",
    "application": {
    "type": "com.atlassian.confluence",
    "name": "Confluence"
    },
    "relationship": "mentioned in",
    "object": {
    "url": "https://example.atlassian.net/wiki/pages/viewpage.action?pageId=987654",
    "title": "Page",
    "icon": {

    . . .

    }
  3. The critical information you're looking for there is line 4, which contains your Confluence globalId, a combination of your Confluence integration's appId and the specific Confluence pageId where the ticket is mentioned.
  4. Copy the globalId, and you can form the JQL query you're after, which is "show me all the Jira issues linked on Confluence page ID 987654":
    issue in issuesWithRemoteLinksByGlobalId("abc-123-cde-456&pageId=987654") 

Finding the appId is the hard part of this, and the reason we've done this whole silly API request. Once you've identified your appId using the steps above, you can construct queries using any Confluence pageId by replacing the pageId bit of the query (987654) with the ID of any page on Confluence. The pageId is, of course, the number after /pages/ in the Confluence page's URL. Now you're equipped to use issuesWithRemoteLinksByGlobalId() against any page in your Confluence instance.

Hope that helps!

Thank you! This is really useful.

In the meantime we started to use a plugin for this kind of query:

https://marketplace.atlassian.com/plugins/ca.nuum.impact/server/overview

 

But still this JQL trick can be really useful for scripts!

Have a great day!

Béla

This is an old question but I recently encountered it and will offer what I have found. I used the REST API to get an example of a global ID. It doesn't appear to be something you can find from the UI. Not entirely anyway. What I found on our systems is that the global ID is in the following format "appId=<Confluence AppID GUID>&pageId=<Confluence Page ID>". I tried a couple of different JIRA issues mentioned in various pages and it seems the appID is always the same for the same Confluence instance and the pageId is what you find in the URL on Confluence. When I query in JQL using this Global Id it appears to only match JIRA Issues that are mentioned in Confluence using the JIRA Macro in Confluence. Simply stating the JIRA ID in Confluence is not enough or it to be "Mentioned In".

 

I hope this helps.

Hi Scott,

Hey i have no answer to give, i am here to ask some questions.

My Scenario is  :

In our JIRA, there are some issues which are linked to remote applications which i do not have access, when i filter all those issues and export to excel, there are no links shown related to the remote applications in the exported excel.

Can you please help me to get an solution for it.

Suggest me if this can be achieved by REST API.

Thanks in advance.

Suggest an answer

Log in or Join to answer
Community showcase
Sarah Schuster
Posted Jan 29, 2018 in Jira

What are common themes you've seen across successful & failed Jira Software implementations?

Hey everyone! My name is Sarah Schuster, and I'm a Customer Success Manager in Atlassian specializing in Jira Software Cloud. Over the next few weeks I will be posting discussion topics (8 total) to ...

3,296 views 14 20
Join discussion

Atlassian User Groups

Connect with like-minded Atlassian users at free events near you!

Find a group

Connect with like-minded Atlassian users at free events near you!

Find my local user group

Unfortunately there are no AUG chapters near you at the moment.

Start an AUG

You're one step closer to meeting fellow Atlassian users at your local meet up. Learn more about AUGs

Groups near you
Atlassian Team Tour

Join us on the Team Tour

We're bringing product updates and pro tips on teamwork to ten cities around the world.

Save your spot