Developer Portal for YouTrack and Hub Help

Sub-articles

This resource lets you work with the sub-articles of the current article.

Resource

/api/articles/{articleID}/childArticles

Returned entity

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

Supported methods

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.

Read a List of Articles

Get the list of sub-articles of the current one.

Required permissions

Requires Read Article permission for the parent article and the sub-articles. If article visibility is limited to some users or groups, the current user should be a part of this set or have the Override Visibility Restrictions permission. For the article reporter only the Create Article permission is required.

Request syntax

GET /api/articles/{articleID}/childArticles?{fields}&{$top}&{$skip}

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.

$skip

Int

Optional. Lets you set a number of returned entities to skip before returning the first one.

$top

Int

Optional. Lets you specify the maximum number of entries that are returned in the response. If you don't set the $top value, the server limits the maximum number of returned entries.

The server returns a maximum of 42 entries for most resources that return collections. For more information, see Pagination.

Sample

Sample request

https://example.youtrack.cloud/api/articles/NP-A-7/childArticles?fields=id,summary,idReadable

Sample response body

[ { "idReadable": "NP-A-1", "summary": "The Basics of the Process", "id": "226-0", "$type": "Article" } ]

Add a New Article

Add a new sub-article to the current article.

Required permissions

Requires permissions: Update Article for both articles

Request syntax

POST /api/articles/{articleID}/childArticles?{fields}&{muteUpdateNotifications}

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.

muteUpdateNotifications

Boolean

Set this parameter to true if no notifications should be sent on changes made by this request. This doesn't mute notifications sent by any workflow rules. Using this parameter requires Apply Commands Silently permission in all projects affected by the request. Available since 2021.3.

Sample

To link an existing article as a sub-article to the current one, include the database ID of the sub-article in the body of the request.

Sample request

https://example.youtrack.cloud/api/articles/NP-A-7/childArticles?fields=id,idReadable,summary

Sample request body

{ "idReadable": "NP-A-5", "id": "226-4", "$type": "Article" }

Sample response body

{ "idReadable": "NP-A-5", "summary": "Documentation", "id": "226-4", "$type": "Article" }
Last modified: 30 April 2024