Developer Portal for YouTrack and Hub Help

Reference

Represents a reference entity. Reference is a link from one article to another. When an article that's being imported contains a link to another article, this link is imported as a temporary string at first. This approach ensures that links to articles that are not imported yet are not lost. When import is finished, temporary strings are replaced with ordinary references to existing articles when possible.

Properties

Name

Type

Description

documentType

string

The type of document in YouTrack where the reference points to. The expected value is `page`.

link

string

The URL of the linked article. If the linked article is not imported for some reason, this URL will be shown instead of a link.

linkedDocumentId

string

The ID of the linked document.

refToReplace

string

The temporary reference string. When import is finished, this string will be replaced with a link to a real article.

type

'reference'

The type of the custom field.

Last modified: 20 January 2023