Cloud
Jira Cloud platform / Reference / REST API v3

This resource represents issue link types. Use it to get, create, update, and delete link issue types as well as get lists of all link issue types.

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

GET

Get issue link types

Returns a list of all issue link types.

To use this operation, the site must have issue linking enabled.

This operation can be accessed anonymously.

Permissions required: Browse projects project permission for a project in the site.

Data Security Policy: Exempt from app access rules
Scopes
ClassicRECOMMENDED:read:jira-work
Granular:read:issue-link-type:jira

Connect app scope requiredREAD

Request

This request has no parameters.

Responses

Returned if the request is successful.

application/json

IssueLinkTypes

A list of issue link type beans.

GET/rest/api/3/issueLinkType
1 2 3 4 5 6 7 8 9 10 11 12 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import api, { route } from "@forge/api"; const response = await api.asUser().requestJira(route`/rest/api/3/issueLinkType`, { headers: { 'Accept': 'application/json' } }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.json());
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 { "issueLinkTypes": [ { "id": "1000", "inward": "Duplicated by", "name": "Duplicate", "outward": "Duplicates", "self": "https://your-domain.atlassian.net/rest/api/3/issueLinkType/1000" }, { "id": "1010", "inward": "Blocked by", "name": "Blocks", "outward": "Blocks", "self": "https://your-domain.atlassian.net/rest/api/3/issueLinkType/1010" } ] }
POST

Create issue link type

Creates an issue link type. Use this operation to create descriptions of the reasons why issues are linked. The issue link type consists of a name and descriptions for a link's inward and outward relationships.

To use this operation, the site must have issue linking enabled.

Permissions required: Administer Jira global permission.

Data Security Policy: Exempt from app access rules
Scopes
ClassicRECOMMENDED:manage:jira-configuration
Granular:write:issue-link-type:jira

Connect app scope requiredADMIN

Request

Request bodyapplication/json

id

string

inward

string

name

string

outward

string

Responses

Returned if the request is successful.

application/json

IssueLinkType

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.
POST/rest/api/3/issueLinkType
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import api, { route } from "@forge/api"; var bodyData = `{ "inward": "Duplicated by", "name": "Duplicate", "outward": "Duplicates" }`; const response = await api.asUser().requestJira(route`/rest/api/3/issueLinkType`, { method: 'POST', headers: { 'Accept': 'application/json', 'Content-Type': 'application/json' }, body: bodyData }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.json());
201Response
1 2 3 4 5 6 7 { "id": "1000", "inward": "Duplicated by", "name": "Duplicate", "outward": "Duplicates", "self": "https://your-domain.atlassian.net/rest/api/3/issueLinkType/1000" }
GET

Get issue link type

Returns an issue link type.

To use this operation, the site must have issue linking enabled.

This operation can be accessed anonymously.

Permissions required: Browse projects project permission for a project in the site.

Data Security Policy: Exempt from app access rules
Scopes
ClassicRECOMMENDED:read:jira-work
Granular:read:issue-link-type:jira

Connect app scope requiredREAD

Request

Path parameters

issueLinkTypeId

string

Required

Responses

Returned if the request is successful.

application/json

IssueLinkType

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.
GET/rest/api/3/issueLinkType/{issueLinkTypeId}
1 2 3 4 5 6 7 8 9 10 11 12 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import api, { route } from "@forge/api"; const response = await api.asUser().requestJira(route`/rest/api/3/issueLinkType/{issueLinkTypeId}`, { headers: { 'Accept': 'application/json' } }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.json());
200Response
1 2 3 4 5 6 7 { "id": "1000", "inward": "Duplicated by", "name": "Duplicate", "outward": "Duplicates", "self": "https://your-domain.atlassian.net/rest/api/3/issueLinkType/1000" }
PUT

Update issue link type

Updates an issue link type.

To use this operation, the site must have issue linking enabled.

Permissions required: Administer Jira global permission.

Data Security Policy: Exempt from app access rules
Scopes
ClassicRECOMMENDED:manage:jira-configuration
Granular:read:issue-link-type:jira, write:issue-link-type:jira

Connect app scope requiredADMIN

Request

Path parameters

issueLinkTypeId

string

Required

Request bodyapplication/json

id

string

inward

string

name

string

outward

string

Responses

Returned if the request is successful.

application/json

IssueLinkType

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.
PUT/rest/api/3/issueLinkType/{issueLinkTypeId}
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import api, { route } from "@forge/api"; var bodyData = `{ "inward": "Duplicated by", "name": "Duplicate", "outward": "Duplicates" }`; const response = await api.asUser().requestJira(route`/rest/api/3/issueLinkType/{issueLinkTypeId}`, { method: 'PUT', headers: { 'Accept': 'application/json', 'Content-Type': 'application/json' }, body: bodyData }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.json());
200Response
1 2 3 4 5 6 7 { "id": "1000", "inward": "Duplicated by", "name": "Duplicate", "outward": "Duplicates", "self": "https://your-domain.atlassian.net/rest/api/3/issueLinkType/1000" }
DEL

Delete issue link type

Deletes an issue link type.

To use this operation, the site must have issue linking enabled.

Permissions required: Administer Jira global permission.

Data Security Policy: Exempt from app access rules
Scopes
ClassicRECOMMENDED:manage:jira-configuration
Granular:delete:issue-link-type:jira

Connect app scope requiredADMIN

Request

Path parameters

issueLinkTypeId

string

Required

Responses

Returned if the request is successful.

DEL/rest/api/3/issueLinkType/{issueLinkTypeId}
1 2 3 4 5 6 7 8 9 10 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import api, { route } from "@forge/api"; const response = await api.asUser().requestJira(route`/rest/api/3/issueLinkType/{issueLinkTypeId}`, { method: 'DELETE' }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.text());

Rate this page: