Operations with Specific IssueLinkType
This resource provides operations with issue link types.
Resource | |
Returned entity | IssueLinkType. For the description of the entity attributes, see Supported Fields section. |
Supported methods |
|
IssueLinkType attributes
Represents the settings of a link type in YouTrack.
This table describes attributes of the IssueLinkType entity.
To receive an attribute in the response from server, specify it explicitly in the request parameter
fields.To update an attribute, provide it in the body of a POST request.
Field | Type | Description |
|---|---|---|
name | String | The name of the issue link type. |
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. |
sourceToTarget | String | The outward name of the issue link type. |
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. |
targetToSource | String | The inward name of the issue link type. |
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. |
directed | Boolean | If |
aggregation | Boolean | If |
readOnly | Boolean | If |
Read a Specific IssueLinkType
Get the attributes of the specified issue link type.
Request syntax
GET /api/issueLinkTypes/{typeID}?{fields}{typeID} | ID of the issue link type. |
Request parameters
Parameter | Type | Description |
|---|---|---|
fields | String | A list of IssueLinkType attributes that should be returned in the response. If no field is specified,only the |
Sample
Sample request URI
https://example.myjetbrains.com/youtrack/api/issueLinkTypes/80-1?fields=aggregation,directed,id,name,readOnly,sourceToTarget,targetToSourceSample response body
{
"readOnly": false,
"targetToSource": "depends on",
"directed": true,
"aggregation": false,
"sourceToTarget": "is required for",
"name": "Depend",
"id": "80-1",
"$type": "IssueLinkType"
}Update a Specific IssueLinkType
Update the specified issue link type.
Required permissions
Requires Low-level Admin Write permission.
Request syntax
POST /api/issueLinkTypes/{typeID}?{fields}{typeID} | ID of the issue link type. |
Request parameters
Parameter | Type | Description |
|---|---|---|
fields | String | A list of IssueLinkType attributes that should be returned in the response. If no field is specified,only the |
Sample
Sample request URI
https://example.myjetbrains.com/youtrack/api/issueLinkTypes/80-9?fields=aggregation,directed,id,name,readOnly,sourceToTarget,targetToSourceSample request body
{
"name": "Group",
"targetToSource": "Part of",
"sourceToTarget": "Part of",
"aggregation": true
}Sample response body
{
"sourceToTarget": "Part of",
"directed": false,
"aggregation": true,
"targetToSource": "Part of",
"readOnly": false,
"name": "Group",
"id": "80-9",
"$type": "IssueLinkType"
}Delete a Specific IssueLinkType
Delete the link type and its usages.
Required permissions
Requires Low-level Admin Write permission.
Request syntax
DELETE /api/issueLinkTypes/{typeID}{typeID} | Database ID of IssueLinkType |
Request parameters
Parameter | Type | Description |
|---|---|---|
fields | String | A list of IssueLinkType attributes that should be returned in the response. If no field is specified,only the |