telligentIdeas_v1_challenges Script API

Ben Tiedt — Wed, 20 Nov 2019 14:52:54 GMT

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

Enables scripted content fragments to use Ideations

Properties
Create
Delete
Get
List
Update

Properties

Name	Access	Type	Description
ContentTypeId	Read	`Guid`	Ideations content type identifier
Current	Read	`[[Challenge Script API Type\|Challenge]]`	Current contextual Ideation
TotalLicensedRemaining	Read	`Int32`	Total number licensed ideations

Methods

Create

Creates a Challenge

Velocity

#set($challengeResponse = $telligentIdeas_v1_challenges.Create($groupId, $name, "%{ AllowMultipleVotes = $allowMultipleVotesArg, ApplicationKey = $applicationKeyArg, Description = $descriptionArg, IsEnabled = $isEnabledArg, IsModerated = $isModeratedArg, MaximumVotesPerIdea = $maximumVotesPerIdeaArg, MaximumVotesPerUser = $maximumVotesPerUserArg, RequiresCategory = $requiresCategoryArg }"))

JavaScript

var challengeResponse = telligentIdeas_v1_challenges.Create(groupId, name, { AllowMultipleVotes: allowMultipleVotesArg, ApplicationKey: applicationKeyArg, Description: descriptionArg, IsEnabled: isEnabledArg, IsModerated: isModeratedArg, MaximumVotesPerIdea: maximumVotesPerIdeaArg, MaximumVotesPerUser: maximumVotesPerUserArg, RequiresCategory: requiresCategoryArg });

Parameters

Name	Type	Description	Required
groupId	`Int32`	Group Id	Required
name	`String`	Name	Required
AllowMultipleVotes	`Boolean`	Allow Multiple Votes	Optional
ApplicationKey	`String`	Application Key	Optional
Description	`String`	Description	Optional
IsEnabled	`Boolean`	Is Enabled	Optional
IsModerated	`Boolean`	Is Moderated	Optional
MaximumVotesPerIdea	`Int32`	The maximum number of votes a user can cast for a given idea. Not setting this value or setting it to 0 will allow users to use as many votes as they have available on any given idea. This setting is only valid when multiple votes are permitted.	Optional
MaximumVotesPerUser	`Int32`	The maximum number of votes a user can cast within this ideation. Not setting this value or setting it to 0 will result in vote per user per idea.	Optional
RequiresCategory	`Boolean`	Requires Category	Optional

Returns

[[Challenge Script API Type|Challenge]]

Delete

Deletes a Challenge

Velocity

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

JavaScript

var additionalInfoResponse = telligentIdeas_v1_challenges.Delete(id);

Parameters

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

Returns

[[AdditionalInfo Script API Type|AdditionalInfo]]

Get

Gets a Challenge

Velocity

#set($challengeResponse = $telligentIdeas_v1_challenges.Get($id))

JavaScript

var challengeResponse = telligentIdeas_v1_challenges.Get(id);

Parameters

Name	Type	Description	Required	Default	Options
id	`Guid`	Idea Id	Required

Returns

[[Challenge Script API Type|Challenge]]

List

Lists Ideations

Velocity

#set($pagedListResponse = $telligentIdeas_v1_challenges.List($groupId, "%{ ContentIds = $contentIdsArg, IncludeSubGroups = $includeSubGroupsArg, NameQuery = $nameQueryArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, SortBy = $sortByArg, SortOrder = $sortOrderArg }"))

JavaScript

var pagedListResponse = telligentIdeas_v1_challenges.List(groupId, { ContentIds: contentIdsArg, IncludeSubGroups: includeSubGroupsArg, NameQuery: nameQueryArg, PageIndex: pageIndexArg, PageSize: pageSizeArg, SortBy: sortByArg, SortOrder: sortOrderArg });

Parameters

Name	Type	Description	Required	Default	Options
groupId	`Int32`	Group Id	Required
ContentIds	`String`	Comma separated list of ApplicationIds. Used to limit to a specific set of ideas as well as sort order if SoryBy is set to ApplicationIdsOrder.	Optional
IncludeSubGroups	`Boolean`	Include Sub Groups	Optional	False
NameQuery	`String`	Name Query	Optional
PageIndex	`Int32`	Specify the page number of paged results to return. Zero-based index.	Optional	0
PageSize	`Int32`	Specify the number of results to return per page.	Optional	20
SortBy	`String`	Sort By	Optional	date	applicationidsorder, date, lastpost, name, totalposts
SortOrder	`String`	Sort Order	Optional	descending	ascending, descending

Returns

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

Update

Updates a Challenge

Velocity

#set($challengeResponse = $telligentIdeas_v1_challenges.Update($id, "%{ AllowMultipleVotes = $allowMultipleVotesArg, ApplicationKey = $applicationKeyArg, Description = $descriptionArg, GroupId = $groupIdArg, IsEnabled = $isEnabledArg, IsModerated = $isModeratedArg, MaximumVotesPerIdea = $maximumVotesPerIdeaArg, MaximumVotesPerUser = $maximumVotesPerUserArg, Name = $nameArg, RequiresCategory = $requiresCategoryArg }"))

JavaScript

var challengeResponse = telligentIdeas_v1_challenges.Update(id, { AllowMultipleVotes: allowMultipleVotesArg, ApplicationKey: applicationKeyArg, Description: descriptionArg, GroupId: groupIdArg, IsEnabled: isEnabledArg, IsModerated: isModeratedArg, MaximumVotesPerIdea: maximumVotesPerIdeaArg, MaximumVotesPerUser: maximumVotesPerUserArg, Name: nameArg, RequiresCategory: requiresCategoryArg });

Parameters

Name	Type	Description	Required
id	`Guid`	Id	Required
AllowMultipleVotes	`Boolean`	Allow Multiple Votes	Optional
ApplicationKey	`String`	Application Key	Optional
Description	`String`	Description	Optional
GroupId	`Int32`	group id	Optional
IsEnabled	`Boolean`	Is Enabled	Optional
IsModerated	`Boolean`	Is Moderated	Optional
MaximumVotesPerIdea	`Int32`	The maximum number of votes a user can cast for a given idea. Setting to zero(0) will allow a user to use as many votes as they have available on any idea. This setting is only valid when multiple votes are permitted.	Optional
MaximumVotesPerUser	`Int32`	The maximum number of votes a user can cast within this ideation. To reset this back to 1 vote per user per idea, set it to 0.	Optional
Name	`String`	Name	Optional
RequiresCategory	`Boolean`	Requires Category	Optional

Returns

[[Challenge Script API Type|Challenge]]