Operations with Specific IssueLinkType

This resource provides operations with issue link types.

Resource	/api/issueLinkTypes/{typeID}
Returned entity	IssueLinkType. For the description of the entity attributes, see Supported Fields section.
Supported methods	`GET`: Read a Specific IssueLinkType. `POST`: Update a Specific IssueLinkType. `DELETE`: Delete a Specific IssueLinkType.

IssueLinkType attributes

Represents the settings of a link type in YouTrack.

Related Resources

Below you can find the list of resources that let you work with this entity.

Issue Link Types

Attributes

This table describes attributes of the IssueLinkType entity.

To receive an attribute in the response from the server, specify it explicitly in the fields request parameter.
To update an attribute, provide it in the body of a POST request.

Field	Type	Description
id	String	The ID of the issue link type. `Read-only`.
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 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 `entityID` is returned.

Sample

Sample request

                https://example.youtrack.cloud/api/issueLinkTypes/80-1?fields=aggregation,directed,id,name,readOnly,sourceToTarget,targetToSource
            

Sample 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 permissions: Low-level Admin Write

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 `entityID` is returned.

Sample

Sample request

                https://example.youtrack.cloud/api/issueLinkTypes/80-9?fields=aggregation,directed,id,name,readOnly,sourceToTarget,targetToSource
            

Sample 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 permissions: Low-level Admin Write

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 `entityID` is returned.

Sample

Sample request

https://example.youtrack.cloud/api/issueLinkTypes/80-9

Last modified: 7 November 2024