This resource represents links between issues. Use it to get, create, and delete links between issues.

To use it, the site must have issue linking enabled.

Hierarchy

  • CommonHttpService
    • IssueLinksService

Constructors

  • Internal

    Create a new instance of the service.

    Parameters

    • getClientInstance: (() => CommonHttpClient)
        • (): CommonHttpClient
        • Returns CommonHttpClient

    Returns IssueLinksService

Methods

  • Returns an issue link.

    This operation can be accessed anonymously.

    Permissions required:

    Parameters

    • params: {
          linkId: string;
      }
      • linkId: string

        The ID of the issue link.

    Returns Promise<IssueLink>

    Returned if the request is successful.

    example:

    {
    "id": "10001",
    "inwardIssue": {
    "fields": {
    "issuetype": {
    "avatarId": 10002,
    "description": "A problem with the software.",
    "entityId": "9d7dd6f7-e8b6-4247-954b-7b2c9b2a5ba2",
    "hierarchyLevel": 0,
    "iconUrl": "https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10316&avatarType=issuetype\",",
    "id": "1",
    "name": "Bug",
    "scope": {
    "project": {
    "id": "10000"
    },
    "type": "PROJECT"
    },
    "self": "https://your-domain.atlassian.net/rest/api/3/issueType/1",
    "subtask": false
    },
    "priority": {
    "description": "Very little impact.",
    "iconUrl": "https://your-domain.atlassian.net/images/icons/priorities/trivial.png",
    "id": "2",
    "name": "Trivial",
    "self": "https://your-domain.atlassian.net/rest/api/3/priority/5",
    "statusColor": "#cfcfcf"
    },
    "status": {
    "description": "The issue is closed.",
    "iconUrl": "https://your-domain.atlassian.net/images/icons/closed.gif",
    "id": "5",
    "name": "Closed",
    "self": "https://your-domain.atlassian.net/rest/api/3/status/5",
    "statusCategory": {
    "colorName": "green",
    "id": 9,
    "key": "completed",
    "self": "https://your-domain.atlassian.net/rest/api/3/statuscategory/9"
    }
    }
    },
    "id": "10004",
    "key": "PR-3",
    "self": "https://your-domain.atlassian.net/rest/api/3/issue/PR-3"
    },
    "outwardIssue": {
    "fields": {
    "issuetype": {
    "avatarId": 1,
    "description": "A task that needs to be done.",
    "hierarchyLevel": 0,
    "iconUrl": "https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10299&avatarType=issuetype\",",
    "id": "3",
    "name": "Task",
    "self": "https://your-domain.atlassian.net/rest/api/3/issueType/3",
    "subtask": false
    },
    "priority": {
    "description": "Major loss of function.",
    "iconUrl": "https://your-domain.atlassian.net/images/icons/priorities/major.png",
    "id": "1",
    "name": "Major",
    "self": "https://your-domain.atlassian.net/rest/api/3/priority/3",
    "statusColor": "#009900"
    },
    "status": {
    "description": "The issue is currently being worked on.",
    "iconUrl": "https://your-domain.atlassian.net/images/icons/progress.gif",
    "id": "10000",
    "name": "In Progress",
    "self": "https://your-domain.atlassian.net/rest/api/3/status/10000",
    "statusCategory": {
    "colorName": "yellow",
    "id": 1,
    "key": "in-flight",
    "name": "In Progress",
    "self": "https://your-domain.atlassian.net/rest/api/3/statuscategory/1"
    }
    }
    },
    "id": "10004L",
    "key": "PR-2",
    "self": "https://your-domain.atlassian.net/rest/api/3/issue/PR-2"
    },
    "type": {
    "id": "1000",
    "inward": "Duplicated by",
    "name": "Duplicate",
    "outward": "Duplicates",
    "self": "https://your-domain.atlassian.net/rest/api/3/issueLinkType/1000"
    }
    }

    GET /rest/api/3/issueLink/{linkId} @scopes-current read:jira-work @scopes-beta read:field:jira, read:issue-link-type:jira, read:issue:jira, read:issue-type:jira, read:priority:jira, read:status:jira, read:avatar:jira, read:issue.time-tracking:jira, read:project-category:jira, read:project:jira, read:user:jira

  • Creates a link between two issues. Use this operation to indicate a relationship between two issues and optionally add a comment to the from (outward) issue. To use this resource the site must have Issue Linking enabled.

    This resource returns nothing on the creation of an issue link. To obtain the ID of the issue link, use https://your-domain.atlassian.net/rest/api/3/issue/[linked issue key]?fields=issuelinks.

    If the link request duplicates a link, the response indicates that the issue link was created. If the request included a comment, the comment is added.

    This operation can be accessed anonymously.

    Permissions required:

    • Browse project project permission for all the projects containing the issues to be linked,
    • Link issues project permission on the project containing the from (outward) issue,
    • If issue-level security is configured, issue-level security permission to view the issue.
    • If the comment has visibility restrictions, belongs to the group or has the role visibility is restricted to.

    Parameters

    Returns Promise<unknown>

    Returned if the request is successful.

    POST /rest/api/3/issueLink @scopes-current write:jira-work @scopes-beta write:comment:jira, write:issue:jira, write:issue-link:jira

  • Method to initialize the class. Normally used to set up validation rules.

    Returns void