Operations with Specific Article
This resource lets you access articles in the YouTrack knowledge base.
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. |
Read an article with a specific ID.
Requires the Read Article permission. 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}?{fields}{articleID} | ID of the article. You can specify either the database ID of the article (for example, |
|---|
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-1?fields=hasStar,content,created,updated,id,idReadable,reporter(name),summary,project(shortName),content{
"created": 1593001508713,
"project": {
"shortName": "NP",
"$type": "Project"
},
"idReadable": "NP-A-1",
"updated": 1605620052796,
"hasStar": true,
"content": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
"summary": "Getting Started with Articles in YouTrack",
"reporter": {
"name": "John Smith",
"$type": "User"
},
"id": "226-0",
"$type": "Article"
}Update a single article.
Requires Create Article permission for the article's reporter and Update Article permission otherwise.
POST /api/articles/{articleID}?{fields}&{muteUpdateNotifications}{articleID} | ID of the article. You can specify either the database ID of the article (for example, |
|---|
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-1?fields=hasStar,content,created,updated,id,idReadable,reporter(name),summary,project(shortName),content{
"summary": "Let Us Document Our Process",
"content": "Here are the guidelines for the development team:\n1. Cooperation.\n2. Collaboration.\n3. Appreciation."
}{
"created": 1593001508713,
"idReadable": "NP-A-1",
"updated": 1629809020517,
"hasStar": true,
"project": {
"shortName": "NP",
"$type": "Project"
},
"summary": "Let Us Document Our Process",
"reporter": {
"name": "John Smith",
"$type": "User"
},
"content": "Here are the guidelines for the development team:\n1. Cooperation.\n2. Collaboration.\n3. Appreciation.",
"id": "226-0",
"$type": "Article"
}Delete the article. Note that this operation can not be undone.
Requires permissions: Delete Article
DELETE /api/articles/{articleID}{articleID} | ID of the article. You can specify either the database ID of the article (for example, |
|---|
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-8