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.
Supported methods	`GET`: Parent Article.

Article attributes

Represents an article.

Extends BaseArticle

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`.
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 article title. `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`.

Read a Specific Article

Get the article that is the parent for the current one.

Request syntax

GET /api/articles/{articleID}/parentArticle?{fields}

Request parameters

Parameter	Type	Description
fields	String	A list of Article 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/articles/NP-A-1/parentArticle?fields=id,idReadable,summary
            

Sample response body

                {
                  "idReadable": "NP-A-7",
                  "summary": "Let's test!",
                  "id": "226-6",
                  "$type": "Article"
                }
            

Last modified: 24 February 2023