Operations with Specific Article

This resource lets you access articles in the YouTrack knowledge base.

Resource	/api/articles/{articleID}
Returned entity	Article. For the description of the entity attributes, see Supported Fields section.
Supported methods	`GET`: Read a Specific Article. `POST`: Update a Specific Article. `DELETE`: Delete a Specific Article.

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 Specific Article

Read an article with a specific ID.

Required permissions

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.

Request syntax

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

{articleID}

ID of the article. You can specify either the database ID of the article (for example, 226-0) or the article ID in the project (for example, NP-A-1).

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?fields=hasStar,content,created,updated,id,idReadable,reporter(name),summary,project(shortName),content
            

Sample response body

                {
                  "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 Specific Article

Update a single article.

Required permissions

Requires Create Article permission for the article's reporter and Update Article permission otherwise.

Request syntax

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

{articleID}

ID of the article. You can specify either the database ID of the article (for example, 226-0) or the article ID in the project (for example, NP-A-1).

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

Sample request

                https://example.youtrack.cloud/api/articles/NP-A-1?fields=hasStar,content,created,updated,id,idReadable,reporter(name),summary,project(shortName),content
            

Sample request body

                {
                  "summary": "Let Us Document Our Process",
                  "content": "Here are the guidelines for the development team:\n1. Cooperation.\n2. Collaboration.\n3. Appreciation."
                }
            

Sample response body

                {
                  "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 a Specific Article

Delete the article. Note that this operation can not be undone.

Required permissions

Requires permissions: Delete Article

Request syntax

DELETE /api/articles/{articleID}

{articleID}

ID of the article. You can specify either the database ID of the article (for example, 226-0) or the article ID in the project (for example, NP-A-1).

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-8

Last modified: 7 November 2024