Developer Portal for YouTrack and Hub 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.

Related Resources

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

Extends BaseArticle

Attributes

This table describes attributes of the Article 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 article. Read-only.

attachments

Array of ArticleAttachments

The list of files attached to the article.

childArticles

Array of Articles

The list of sub-articles of the current one.

comments

Array of ArticleComments

The list of comments to the article.

content

String

The content of the article. Can be null.

created

Long

The timestamp in milliseconds indicating the moment when the article was created. Stored as a unix timestamp at UTC. Read-only.

externalArticle

ExternalArticle

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

hasChildren

Boolean

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

hasStar

Boolean

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

idReadable

String

The article ID. Read-only.

ordinal

Long

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

parentArticle

Article

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

pinnedComments

Array of ArticleComments

The list of comments that are pinned in the article. Read-only.

project

Project

The project where the article belongs. Read-only.

reporter

User

The user who created the article. Can be null.

summary

String

The article title. Can be null.

tags

Array of Tags

The list of tags that are added to the article.

updated

Long

The timestamp in milliseconds indicating the last update of the article. Stored as a unix timestamp at UTC. Read-only.

updatedBy

User

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

visibility

Visibility

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

Last modified: 11 June 2024