YouTrack InCloud 2019.2 Help

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

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. 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

Request syntax

GET /api/issueLinkTypes/{typeID}?{fields}

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 URI

https://example.myjetbrains.com/youtrack/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

Request syntax

POST /api/issueLinkTypes/{typeID}?{fields}

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.

Delete a Specific IssueLinkType

Removes the link type and its usages.

Request syntax

DELETE /api/issueLinkTypes/{typeID}

Sample

Sample request URI

https://example.myjetbrains.com/youtrack/api/issueLinkTypes/80-9
Last modified: 17 July 2019