Operations with Specific Sub-articles
This resource lets you work with the sub-articles of the current article.
Resource | |
|---|---|
Returned entity | Article. For the description of the entity attributes, see Supported Fields section. |
Supported methods |
|
Represents an article.
Below you can find the list of resources that let you work with this entity.
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
fieldsrequest parameter.To update an attribute, provide it in the body of a POST request.
Field | Type | Description |
|---|---|---|
id | String | The ID of the article. |
attachments | The list of files attached to the article. | |
childArticles | The list of sub-articles of the current one. | |
comments | The list of comments to the article. | |
content | String | The content of the article. |
created | Long | The timestamp in milliseconds indicating the moment when the article was created. Stored as a unix timestamp at UTC. |
externalArticle | The reference to the article or a similar object in the originating third-party system. | |
hasChildren | Boolean | When |
hasStar | Boolean |
|
idReadable | String | The article ID. |
ordinal | Long | The position of the article in the tree. |
parentArticle | The parent article of the current one. | |
pinnedComments | The list of comments that are pinned in the article. | |
project | The project where the article belongs. | |
reporter | The user who created the article. | |
summary | String | The article title. |
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. |
updatedBy | The user who last updated the article. | |
visibility | Visibility settings of the article. These settings describe who is allowed to see the article. |
Get a specific sub-article of the current one.
Requires Read Article permission for the parent article and the sub-article. 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.
GET /api/articles/{articleID}/childArticles/{articleID}?{fields}{articleID} | The database ID of the target sub-article. |
|---|
Parameter | Type | Description |
|---|---|---|
fields | String | A list of Article attributes that should be returned in the response. If no field is specified, only the |
https://example.youtrack.cloud/api/articles/NP-A-7/childArticles/226-0?fields=id,idReadable,summary{
"idReadable": "NP-A-1",
"summary": "The Basics of the Process",
"id": "226-0",
"$type": "Article"
}Update a specific sub-article.
Requires permissions: Update Article for both articles
POST /api/articles/{articleID}/childArticles/{articleID}?{fields}&{muteUpdateNotifications}{articleID} | The database ID of the target sub-article. |
|---|
Parameter | Type | Description |
|---|---|---|
fields | String | A list of Article attributes that should be returned in the response. If no field is specified, only the |
muteUpdateNotifications | Boolean | Set this parameter to |
https://example.youtrack.cloud/api/articles/NP-A-7/childArticles/226-0?fields=id,idReadable,summary{
"summary": "The Tutorial for the Feature Development"
}{
"idReadable": "NP-A-1",
"summary": "The Tutorial for the Feature Development",
"id": "226-0",
"$type": "Article"
}Remove the parent-child link between the specific sub-article and the current article. This operation does not delete the specified sub-article.
Requires permissions: Update Article for both articles
DELETE /api/articles/{articleID}/childArticles/{articleID}{articleID} | The database ID of the target sub-article. |
|---|
Parameter | Type | Description |
|---|---|---|
fields | String | A list of Article attributes that should be returned in the response. If no field is specified, only the |
https://example.youtrack.cloud/api/articles/NP-A-7/childArticles/226-0