Sub-articles
This resource lets you work with the sub-articles of the current article.
Resource | /api/articles/{articleID}/childArticles/{articleID} |
Returned entity | Article. For the description of the entity attributes, see Supported Fields section. |
Supported methods |
|
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. |
reporter | User | The user who created the article. |
visibility | Visibility | Visibility settings of the article. These settings describe who is allowed to see the article. |
summary | String | The article title. |
content | String | The content of the article. |
attachments | Array of ArticleAttachments | The list of files attached to the article. |
project | Project | The project where the article belongs. |
parentArticle | Article | The parent article of the current one. |
childArticles | Array of Articles | The list of sub-articles of the current one. |
hasChildren | Boolean | When |
updatedBy | User | The user who last updated the article. |
updated | Long | The timestamp when the article was last updated. |
created | Long | The timestamp when the article was created. |
idReadable | String | The article ID. |
ordinal | Long | The position of the article in the tree. |
comments | Array of ArticleComments | The list of comments to the article. |
hasStar | Boolean | |
externalArticle | ExternalArticle | The reference to the article or a similar object in the originating third-party system. |
Read a Specific Article
Get a specific sub-article of the current one.
Required permissions
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.
Request syntax
{articleID} | The database ID of the target sub-article. |
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 |
Sample
Sample request
Sample response body
Update a Specific Article
Update a specific sub-article.
Required permissions
Requires permissions: Update Article for both articles
Request syntax
{articleID} | The database ID of the target sub-article. |
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 |
muteUpdateNotifications | Boolean | Set this parameter to |
Sample
Sample request
Sample request body
Sample response body
Delete a Specific Article
Remove the parent-child link between the specific sub-article and the current article. This operation does not delete the specified sub-article.
Required permissions
Requires permissions: Update Article for both articles
Request syntax
{articleID} | The database ID of the target sub-article. |
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 |