Exposes the article helpfulness response options api to widgets, themes and automation.
Methods
Create
Velocity
#set($helpfulnessResponseTypeResponse = $articles_v1_helpfulnessResponseTypes.Create($articleCollectionId, $name, "%{ RequireMessage = $requireMessageArg }"))
JavaScript
var helpfulnessResponseTypeResponse = articles_v1_helpfulnessResponseTypes.Create(articleCollectionId, name, { RequireMessage: requireMessageArg });
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
articleCollectionId | Guid | The id of the article collection this response type will belong to. | Required | ||
name | String | The name of the response type. | Required | ||
options | Options | Set of optional parameters including: | Required | ||
RequireMessage | Boolean | When true, users will be forced to leave additional feedback when submitting a helpfulness rating with this response type. | Optional |
Returns
Delete
Velocity
#set($additionalInfoResponse = $articles_v1_helpfulnessResponseTypes.Delete($id))
JavaScript
var additionalInfoResponse = articles_v1_helpfulnessResponseTypes.Delete(id);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
id | Int32 | Id | Required |
Returns
Get
Velocity
#set($helpfulnessResponseTypeResponse = $articles_v1_helpfulnessResponseTypes.Get($id))
JavaScript
var helpfulnessResponseTypeResponse = articles_v1_helpfulnessResponseTypes.Get(id);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
id | Int32 | The id of the response type. | Required |
Returns
List
Velocity
#set($apiListResponse = $articles_v1_helpfulnessResponseTypes.List($articleCollectionId))
JavaScript
var apiListResponse = articles_v1_helpfulnessResponseTypes.List(articleCollectionId);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
articleCollectionId | Guid | The id or the article collection to list response types for.. | Required |
Returns
Update
Velocity
#set($helpfulnessResponseTypeResponse = $articles_v1_helpfulnessResponseTypes.Update($id, "%{ Name = $nameArg, RequireMessage = $requireMessageArg }"))
JavaScript
var helpfulnessResponseTypeResponse = articles_v1_helpfulnessResponseTypes.Update(id, { Name: nameArg, RequireMessage: requireMessageArg });
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
id | Int32 | The id of the response type. | Required | ||
options | Options | Set of optional parameters including: | Required | ||
Name | String | The name of the response type. | Optional | ||
RequireMessage | Boolean | When true, users will be forced to leave additional feedback when submitting a helpfulness rating with this response type. | Optional |