articles_v1_helpfulness Script API

Ben Tiedt — Fri, 23 Apr 2021 19:54:33 GMT

Current Revision posted to API Documentation by Ben Tiedt on 04/23/2021 19:54:33

Exposes the article helpfulness api to widgets, themes and automation.

Delete
IsHelpful
List
NotHelpful
Update

Methods

Delete

Velocity

#set($additionalInfoResponse = $articles_v1_helpfulness.Delete($id))

JavaScript

var additionalInfoResponse = articles_v1_helpfulness.Delete(id);

Parameters

Name	Type	Description	Required	Default	Options
id	`Int32`	Id	Required

Returns

[[AdditionalInfo Script API Type|AdditionalInfo]]

IsHelpful

Velocity

#set($helpfulnessResponse = $articles_v1_helpfulness.IsHelpful($articleId))

JavaScript

var helpfulnessResponse = articles_v1_helpfulness.IsHelpful(articleId);

Parameters

Name	Type	Description	Required	Default	Options
articleId	`Guid`	The id article the rating applies to	Required

Returns

[[Helpfulness Script API Type|Helpfulness]]

List

Velocity

#set($pagedListResponse = $articles_v1_helpfulness.List("%{ ArticleId = $articleIdArg, ArticleVersionId = $articleVersionIdArg, AuthorId = $authorIdArg, CollectionId = $collectionIdArg, HelpfulnessResponseTypeId = $helpfulnessResponseTypeIdArg, IncludeIgnored = $includeIgnoredArg, IsHelpful = $isHelpfulArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, ResolvedArticleVersionId = $resolvedArticleVersionIdArg, SortBy = $sortByArg, SortOrder = $sortOrderArg, State = $stateArg }"))

JavaScript

var pagedListResponse = articles_v1_helpfulness.List({ ArticleId: articleIdArg, ArticleVersionId: articleVersionIdArg, AuthorId: authorIdArg, CollectionId: collectionIdArg, HelpfulnessResponseTypeId: helpfulnessResponseTypeIdArg, IncludeIgnored: includeIgnoredArg, IsHelpful: isHelpfulArg, PageIndex: pageIndexArg, PageSize: pageSizeArg, ResolvedArticleVersionId: resolvedArticleVersionIdArg, SortBy: sortByArg, SortOrder: sortOrderArg, State: stateArg });

Parameters

Name	Type	Description	Required	Default	Options
options	Options	Set of optional parameters including:	Required
ArticleId	`Guid`	Filters the items submitted for a specific article regardless of version. A CollectionId or ArticleId is required.	Optional
ArticleVersionId	`Guid`	Filters the items submitted for a specific version of an article. An ArticleId is required.	Optional
AuthorId	`Int32`	The user who submitted the helpfulness feedback.	Optional
CollectionId	`Guid`	Show helpfulness items across an article collection. A CollectionId or ArticleId is required.	Optional
HelpfulnessResponseTypeId	`Int32`	The id of a valid helpfulness response type to filter by.	Optional
IncludeIgnored	`Boolean`	If true, responses flagged to be ignored will be returned.	Optional	False
IsHelpful	`Boolean`	Filters the list to items that are considered helpful only if true, not helpful if false. By default both types will be returned.	Optional
PageIndex	`Int32`	The specific page of the results to return, zero based.	Optional	0
PageSize	`Int32`	The total amount of items to be returned per page of the results.	Optional	20
ResolvedArticleVersionId	`Guid`	Filters the items resolved by a specific published article version. An ArticleId is required.	Optional
SortBy	`String`	The property to sort the list by.	Optional		CreateDate
SortOrder	`String`	The order by which to filter.	Optional		Ascending, Descending
State	`String`	Filters the items by a specific resolution state.	Optional		All, Resolved, Unresolved

Returns

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

NotHelpful

Velocity

#set($helpfulnessResponse = $articles_v1_helpfulness.NotHelpful($articleId, $responseTypeId, "%{ Message = $messageArg }"))

JavaScript

var helpfulnessResponse = articles_v1_helpfulness.NotHelpful(articleId, responseTypeId, { Message: messageArg });

Parameters

Name	Type	Description	Required
articleId	`Guid`	The id article the rating applies to	Required
responseTypeId	`Int32`	The id of a predefined response type for the article collection.	Required
options	Options	Set of optional parameters including:	Required
Message	`String`	User defined feedback for a helpfulness response. Required when the response type specified is configured to require additional feedback.	Optional

Returns

[[Helpfulness Script API Type|Helpfulness]]

Update

Velocity

#set($helpfulnessResponse = $articles_v1_helpfulness.Update($id, "%{ Ignore = $ignoreArg, ResolvedArticleVersionId = $resolvedArticleVersionIdArg, UnresolvedArticleVersionId = $unresolvedArticleVersionIdArg }"))

JavaScript

var helpfulnessResponse = articles_v1_helpfulness.Update(id, { Ignore: ignoreArg, ResolvedArticleVersionId: resolvedArticleVersionIdArg, UnresolvedArticleVersionId: unresolvedArticleVersionIdArg });

Parameters

Name	Type	Description	Required
id	`Int32`	The id of a helpfulness item to update.	Required
options	Options	Set of optional parameters including:	Required
Ignore	`Boolean`	Used to ignore a specific helpfulness item from further action. Ignored items are considered resolved.	Optional
ResolvedArticleVersionId	`Guid`	Specifies that this article version item will potentially resolve this helpfulness item once published. If the version is published, it will mark the item resolved by the specified version.	Optional
UnresolvedArticleVersionId	`Guid`	Removes a version from potentially resolving a feedback item.	Optional

Returns

[[Helpfulness Script API Type|Helpfulness]]