1. APIs
  2. TeamDynamix.Api.KnowledgeBase.Article

Contents

Summary

A Knowledge Base article.

Properties

Name Editable? Required? Type Nullable? Summary
ID Int32 The ID of the article.
AppID Int32 The ID of the Client Portal application containing the article.
AppName String The name of the Client Portal application containing the article.
CategoryID This field is editable through the web API. Int32 The ID of the category associated with the article.
CategoryName String The name of the category associated with the article.
Subject This field is editable through the web API. This field is required. String The subject of the article.
Body This field is editable through the web API. This field is required. String The body of the article.
Summary This field is editable through the web API. String This field is nullable. The summary of the article.
Status This field is editable through the web API. This field is required. TeamDynamix.Api.KnowledgeBase.ArticleStatus The status of the article.
StatusName String The name of the article status.
Attributes This field is editable through the web API. TeamDynamix.Api.CustomAttributes.CustomAttribute[] This field is nullable. The custom attributes associated with the article.
ReviewDateUtc This field is editable through the web API. DateTime This field is nullable. The review date of the article.
Order This field is editable through the web API. This field is required. Double The order of the article among its siblings.
IsPublished This field is editable through the web API. Boolean The published status of the article.
IsPublic This field is editable through the web API. Boolean The public status of the article.
WhitelistGroups This field is editable through the web API. Boolean Whether groups associated with the article are whitelisted or blacklisted for article access.
InheritPermissions This field is editable through the web API. Boolean Whether permissions are inherited from the parent category.
NotifyOwner This field is editable through the web API. Boolean Whether the owner associated with the article should be notified of any feedback.
NotifyOwnerOfReviewDate This field is editable through the web API. Boolean Whether the reviewer will be notified as the review date approaches
RevisionID Int32 The ID of the current revision associated with the article.
RevisionNumber Int32 The number of the current revision associated with the article.
DraftStatus TeamDynamix.Api.KnowledgeBase.DraftStatus This field is nullable. The draft status associated with the article.
CreatedDate DateTime The created date of the article.
CreatedUid Guid The UID of the user who created the article.
CreatedFullName String The full name of the user who created the article.
ModifiedDate DateTime The last modified date of the article.
ModifiedUid Guid The UID of the user who last modified the article.
ModifiedFullName String The full name of the user who last modified the article.
OwnerUid This field is editable through the web API. Guid This field is nullable. The UID of the owning user associated with the article.
OwnerFullName String The full name of the owning user associated with the article.
OwningGroupID This field is editable through the web API. Int32 This field is nullable. The ID of the owning group associated with the article.
OwningGroupName String The name of the owning group associated with the article.
Tags This field is editable through the web API. String[] This field is nullable. The tags associated with the article.
Attachments TeamDynamix.Api.Attachments.Attachment[] This field is nullable. The attachments associated with the article.
Uri String The URI to retrieve the full details of the article via the web API.