km_v1_documents Script API

Ben Tiedt — Wed, 20 Nov 2019 14:53:03 GMT

Current Revision posted to API Documentation by Ben Tiedt on 11/20/2019 14:53:03

Exposes Knowledge Management document APIs to widgets.

Name	Access	Type	Description
ContentTypeId	Read	`Guid`	Content Type Id
Current	Read	`[[Document Script API Type\|Document]]`	Current
HelpfulRatingTypeId	Read	`Guid`	Helpful Rating Type Id

AreRatingsEnabled

#set($booleanResponse = $km_v1_documents.AreRatingsEnabled($contentId))

var booleanResponse = km_v1_documents.AreRatingsEnabled(contentId);

Name	Type	Description	Required	Default	Options
contentId	`Guid`	Content Id	Required

Boolean

#set($documentResponse = $km_v1_documents.Get($contentId))

var documentResponse = km_v1_documents.Get(contentId);

Name	Type	Description	Required	Default	Options
contentId	`Guid`	Content Id	Required

[[Document Script API Type|Document]]

#set($pagedListResponse = $km_v1_documents.List($applicationId, "%{  }"))

var pagedListResponse = km_v1_documents.List(applicationId, {  });

Name	Type	Description	Required	Default	Options
applicationId	`Guid`	Application Id	Required

[[PagedList Script API Type|PagedList]] of [[Document Script API Type|Document]]

#set($additionalInfoResponse = $km_v1_documents.MarkAsViewed($contentId))

var additionalInfoResponse = km_v1_documents.MarkAsViewed(contentId);

Name	Type	Description	Required	Default	Options
contentId	`Guid`	Content Id	Required

[[AdditionalInfo Script API Type|AdditionalInfo]]

#set($additionalInfoResponse = $km_v1_documents.SendFeedback($contentId, $feedback))

var additionalInfoResponse = km_v1_documents.SendFeedback(contentId, feedback);

Name	Type	Description	Required	Default	Options
contentId	`Guid`	Content Id	Required
feedback	`String`	Feedback	Required

[[AdditionalInfo Script API Type|AdditionalInfo]]