Issue Link Types

Last modified: 17 December 2019

Resource	`/api/issueLinkTypes`
Returned entity	IssueLinkType. For the description of the entity attributes, see Supported Fields section.
Supported methods	`GET`: Read a List of IssueLinkTypes. `POST`: Add a New IssueLinkType.

IssueLinkType attributes

This table describes attributes of the IssueLinkType entity.

Field	Type	Description
name	String	The name of the issue link type. `Can be null`.
localizedName	String	The localized name of the issue link type. It is present and can be updated only for predefined issue link types in localized YouTrack installations. `Can be null`.
sourceToTarget	String	The outward name of the issue link type. `Can be null`.
localizedSourceToTarget	String	The localized outward name of the issue link type. It is present and can be updated only for predefined issue link types in localized YouTrack installations. `Can be null`.
targetToSource	String	The inward name of the issue link type. `Can be null`.
localizedTargetToSource	String	The localized inward name of the issue link type. It is present and can be updated only for the predefined issue link types in localized YouTrack installations. `Can be null`.
directed	Boolean	If `true`, the link is directed. Otherwise, `false`.
aggregation	Boolean	If `true`, the link represents aggregation relation. Otherwise, `false`.
readOnly	Boolean	If `true`, link settings cannot be updated. Otherwise, `false`. `Read-only`.

Read a List of IssueLinkTypes

GET /api/issueLinkTypes?{fields}&{$top}&{$skip}

Parameter	Type	Description
fields	String	A list of IssueLinkType attributes that should be returned in the response. If no field is specified,only the `entityID` is returned
$skip	Int	Optional. Lets you set a number of returned entities to skip before returning the first one.
$top	Int	Optional. Lets you specify the maximum number of entries that are returned in the response.

Sample

https://example.myjetbrains.com/youtrack/api/issueLinkTypes?fields=aggregation,directed,id,name,readOnly,sourceToTarget,targetToSource

[
  {
    "readOnly": false,
    "targetToSource": "",
    "directed": false,
    "aggregation": false,
    "sourceToTarget": "relates to",
    "name": "Relates",
    "id": "80-0",
    "$type": "IssueLinkType"
  },
  {
    "readOnly": false,
    "targetToSource": "depends on",
    "directed": true,
    "aggregation": false,
    "sourceToTarget": "is required for",
    "name": "Depend",
    "id": "80-1",
    "$type": "IssueLinkType"
  },
  {
    "readOnly": true,
    "targetToSource": "duplicates",
    "directed": true,
    "aggregation": true,
    "sourceToTarget": "is duplicated by",
    "name": "Duplicate",
    "id": "80-2",
    "$type": "IssueLinkType"
  },
  {
    "readOnly": true,
    "targetToSource": "subtask of",
    "directed": true,
    "aggregation": true,
    "sourceToTarget": "parent for",
    "name": "Subtask",
    "id": "80-3",
    "$type": "IssueLinkType"
  },
  {
    "readOnly": false,
    "targetToSource": "dependent on",
    "directed": true,
    "aggregation": false,
    "sourceToTarget": "required for",
    "name": "Depend 2",
    "id": "80-4",
    "$type": "IssueLinkType"
  }
]

Add a New IssueLinkType

POST /api/issueLinkTypes?{fields}

Parameter	Type	Description
fields	String	A list of IssueLinkType attributes that should be returned in the response. If no field is specified,only the `entityID` is returned

Sample

https://example.myjetbrains.com/youtrack/api/issueLinkTypes

{
  "name": "Part",
  "targetToSource": "Part of",
  "sourceToTarget": "Part of",
  "aggregation": true,
  "directed": false,
  "readOnly": false
}

Issue Link Types﻿

IssueLinkType attributes﻿

Read a List of IssueLinkTypes﻿

Request syntax

Request parameters

Sample﻿

Sample request URI

Sample response body

Add a New IssueLinkType﻿

Required permissions

Request syntax

Request parameters

Sample﻿

Sample request URI

Sample request body

Issue Link Types

IssueLinkType attributes

Read a List of IssueLinkTypes

Sample

Add a New IssueLinkType

Sample