Article - Documentation

new Article(client, properties)

Article class

Parameters:

Name	Type	Description
`client`	TDAPI
`properties`	Object

Properties:

Name	Type	Description
`ID`	Number	The ID of the article.
`CategoryID`	Number	The ID of the article's category - editable.
`CategoryName`	String	The name of article's category.
`Subject`	String	The subject of the article - required, editable.
`Body`	String	The body of the article - required, editable.
`Summary`	Number	The summary of the article - editable.
`Status`	Number	The status of the article (see https://api.teamdynamix.com/TDWebApi/Home/type/TeamDynamix.Api.KnowledgeBase.ArticleStatus) - required, editable.
`Attributes`	Number	The custom attributes of the article - editable.
`ReviewDateUtc`	DateTime	Review date of the article - editable, nullable.
`Order`	Double	The order of the article. Articles are ordered first by this value and then by the subject - required, editable.
`isPublished`	Boolean	Indicates whether the article is published, editable.
`isPublic`	Boolean	Indicates whether the article is public, editable.
`WhitelistGroups`	Boolean	Indicates whether groups assigned to the article are whitelisted or blacklisted from accessing the article in the Knowledge Base, editable.
`InheritPermissions`	Boolean	Indicates whether permissions are inherited from the parent category, editable.
`NotifyOwner`	Boolean	Indicates whether the owner should be notified of any feedback, editable.
`RevisionID`	Number	The ID of the article's current revision.
`RevisionNumber`	Number	The number of the article's current revision.
`CreatedDate`	DateTime	The created date of the article.
`CreatedUid`	Guid	The UID of the article's creator.
`CreatedFullName`	String	The full name of the article's creator.
`ModifiedDate`	DateTime	The date the article was last modified.
`ModifiedUid`	Guid	The UID of the last user to modify the article.
`ModifiedFullName`	String	The name of the last user to modify the article.
`OwnerUid`	Guid	The UID of the article's owner, editable.
`OwnerFullName`	String	The full name of the article's owner, editable.
`OwningGroupID`	Guid	The ID of the group that owns the article, editable.
`OwningGroupName`	String	The name of the group that owns the article, editable.
`Tags`	Array.<String>	The tags associated with the article. Tags are not returned from the search endpoint, editable.
`Attachments`	Array	The article's attachments (see https://api.teamdynamix.com/TDWebApi/Home/type/TeamDynamix.Api.Attachments.Attachment).
`Uri`	String	The URI to retrieve the article.

Source:

structures/article.js, line 40

Methods

getRelated() → {Promise.<Array.<Article>>}

Gets related articles in TDx. API endpoint returns related articles with the body omitted.

Source:

structures/article.js, line 77

Returns:

Type: Promise.<Array.<Article>>

update() → {Promise.<Article>}

Edits the article in TDx.

Source:

structures/article.js, line 57

Returns:

Type: Promise.<Article>