Developer Portal for YouTrack and Hub 2021.3 Help

Parent Article

This resource lets you get the parent article of the current one.

Resource

/api/articles/{articleID}/parentArticle

Returned entity

Article. For the description of the entity attributes, see Supported Fields section.

Article attributes

Represents an article.

Extends BaseArticle

This table describes attributes of the Article 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

reporter

User

The user who created the article. Can be null.

visibility

Visibility

Visibility settings of the article. These settings describe who is allowed to see the article. Can be null.

summary

String

The summary, or the title of the article. Can be null.

content

String

The content of the article. Can be null.

attachments

Array of ArticleAttachments

The list of files attached to the article.

project

Project

The project where the article belongs. Read-only.

parentArticle

Article

The parent article of the current one. Can be null.

childArticles

Array of Articles

The list of sub-articles of the current one.

hasChildren

Boolean

When true, the article has sub-articles. Read-only.

updatedBy

User

The user who last updated the article. Read-only. Can be null.

updated

Long

The timestamp when the article was last updated. Read-only. Can be null.

created

Long

The timestamp when the article was created. Read-only. Can be null.

idReadable

String

The article ID. Read-only.

ordinal

Long

The position of the article in the tree. Read-only.

comments

Array of ArticleComments

The list of comments to the article.

hasStar

Boolean

true if the current user added the "Star" tag to this article. Otherwise, false.

externalArticle

ExternalArticle

The reference to the article or a similar object in the originating third-party system. Read-only. Can be null.

Last modified: 14 September 2021