Create issue link

POST

/rest/api/3/issueLink

Issue links

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.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'http://jira.local:8080/jira/rest//rest/api/3/issueLink' \
--header 'Content-Type: application/json' \
--data-raw '{
    "comment": {
        "body": {
            "content": [
                {
                    "content": [
                        {
                            "text": "Linked related issue!",
                            "type": "text"
                        }
                    ],
                    "type": "paragraph"
                }
            ],
            "type": "doc",
            "version": 1
        },
        "visibility": {
            "identifier": "276f955c-63d7-42c8-9520-92d01dca0625",
            "type": "group",
            "value": "jira-software-users"
        }
    },
    "inwardIssue": {
        "key": "HSP-1"
    },
    "outwardIssue": {
        "key": "MKY-1"
    },
    "type": {
        "name": "Duplicate"
    }
}'

Response Example

201 - Example 1

null

Request

Body Params application/json

comment

object (Comment)

optional

A comment.

body

optional

The comment text in Atlassian Document Format.

properties

array[object (EntityProperty) {2}]

optional

A list of comment properties. Optional on create and update.

visibility

object

optional

The group or role to which this comment is visible. Optional on create and update.

Additional properties

integer | number | string | boolean

optional

inwardIssue

object (LinkedIssue)

required

The ID or key of a linked issue.

string

optional

The ID of an issue. Required if key isn't provided.

key

string

optional

The key of an issue. Required if id isn't provided.

outwardIssue

object (LinkedIssue)

required

The ID or key of a linked issue.

type

object (IssueLinkType)

required

This object is used as follows:

In the issueLink resource it defines and reports on the type of link between the issues. Find a list of issue link types with Get issue link types.

In the issueLinkType resource it defines and reports on issue link types.

string

optional

The ID of the issue link type and is used as follows:

In the issueLink resource it is the type of issue link. Required on create when name isn't provided. Otherwise, read only.

In the issueLinkType resource it is read only.

inward

string

optional

The description of the issue link type inward link and is used as follows:

In the issueLink resource it is read only.

In the issueLinkType resource it is required on create and optional on update. Otherwise, read only.

name

string

optional

The name of the issue link type and is used as follows:

In the issueLink resource it is the type of issue link. Required on create when id isn't provided. Otherwise, read only.

In the issueLinkType resource it is required on create and optional on update. Otherwise, read only.

outward

string

optional

The description of the issue link type outward link and is used as follows:

In the issueLink resource it is read only.

In the issueLinkType resource it is required on create and optional on update. Otherwise, read only.

Examples

Responses

🟢201Returned if the request is successful.

application/json

Body

No schema defined

🟠400Returned if the comment is not created. The response contains an error message indicating why the comment wasn't created. The issue link is also not created.

🟠401Returned if the authentication credentials are incorrect or missing.

🟠404Returned if: * issue linking is disabled. * the user cannot view one or both of the issues. For example, the user doesn't have *Browse project* project permission for a project containing one of the issues. * the user does not have *link issues* pr

Modified at 2023-07-13 03:27:27

Delete worklog property

Get issue link