Create issue link type

POST

/rest/api/3/issueLinkType

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.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'http://jira.local:8080/jira/rest//rest/api/3/issueLinkType' \
--header 'Content-Type: application/json' \
--data-raw '{
    "inward": "Duplicated by",
    "name": "Duplicate",
    "outward": "Duplicates"
}'

Response Example

201 - Success

{"id":"1000","name":"Duplicate","inward":"Duplicated by","outward":"Duplicates","self":"https://your-domain.atlassian.net/rest/api/3/issueLinkType/1000"}

Request

Body Params application/json

This object is used as follows:

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

This object is used as follows:

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.

self

string <uri>

read-onlyoptional

The URL of the issue link type. Read only.

🟠400Returned if the request is invalid.

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

🟠404Returned if: * issue linking is disabled. * the issue link type name is in use. * the user does not have the required permissions.

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

Get issue link types

Get issue link type