telligentIdeas_v1_ideas Script API

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

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

Enables scripted content fragments to use Ideas

Properties
Create
Delete
Get
IncrementViewCount
List
Update
UpDownVoteUI

Properties

Name	Access	Type	Description
ContentTypeId	Read	`Guid`	Ideas content type identifier
Current	Read	`[[Idea Script API Type\|Idea]]`	Current contextual idea

Methods

Create

Creates an idea

Velocity

#set($ideaResponse = $telligentIdeas_v1_ideas.Create($challengeId, $name, $description, "%{ CategoryId = $categoryIdArg, Status = $statusArg, StatusNotes = $statusNotesArg, Tags = $tagsArg, UrlKey = $urlKeyArg }"))

JavaScript

var ideaResponse = telligentIdeas_v1_ideas.Create(challengeId, name, description, { CategoryId: categoryIdArg, Status: statusArg, StatusNotes: statusNotesArg, Tags: tagsArg, UrlKey: urlKeyArg });

Parameters

Name	Type	Description	Required
challengeId	`Guid`	Challenge Id	Required
name	`String`	Name	Required
description	`String`	Description	Required
CategoryId	`Int32`	Category id.	Optional
Status	`String`	Status of idea	Optional
StatusNotes	`String`	Notes on idea status	Optional
Tags	`String`	Comma delimited list of tags	Optional
UrlKey	`String`	Unique url string for idea	Optional

Returns

[[Idea Script API Type|Idea]]

Delete

Deletes an Idea

Velocity

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

JavaScript

var additionalInfoResponse = telligentIdeas_v1_ideas.Delete(id);

Parameters

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

Returns

[[AdditionalInfo Script API Type|AdditionalInfo]]

Get

Gets an Idea

Velocity

#set($ideaResponse = $telligentIdeas_v1_ideas.Get($id))

JavaScript

var ideaResponse = telligentIdeas_v1_ideas.Get(id);

Parameters

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

Returns

[[Idea Script API Type|Idea]]

IncrementViewCount

Increments the views for the specified idea.

Velocity

$telligentIdeas_v1_ideas.IncrementViewCount($ideaId)

JavaScript

telligentIdeas_v1_ideas.IncrementViewCount(ideaId);

Parameters

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

Returns

Nothing

List

Lists Ideas

Velocity

#set($pagedListResponse = $telligentIdeas_v1_ideas.List("%{ CategoryId = $categoryIdArg, ChallengeId = $challengeIdArg, ContentIds = $contentIdsArg, GroupId = $groupIdArg, IncludeSubGroups = $includeSubGroupsArg, IsClosed = $isClosedArg, MaximumVoteCount = $maximumVoteCountArg, MinimumVoteCount = $minimumVoteCountArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, QueryType = $queryTypeArg, ReleasesVotes = $releasesVotesArg, SortBy = $sortByArg, SortOrder = $sortOrderArg, Status = $statusArg, UserId = $userIdArg }"))

JavaScript

var pagedListResponse = telligentIdeas_v1_ideas.List({ CategoryId: categoryIdArg, ChallengeId: challengeIdArg, ContentIds: contentIdsArg, GroupId: groupIdArg, IncludeSubGroups: includeSubGroupsArg, IsClosed: isClosedArg, MaximumVoteCount: maximumVoteCountArg, MinimumVoteCount: minimumVoteCountArg, PageIndex: pageIndexArg, PageSize: pageSizeArg, QueryType: queryTypeArg, ReleasesVotes: releasesVotesArg, SortBy: sortByArg, SortOrder: sortOrderArg, Status: statusArg, UserId: userIdArg });

Parameters

Name	Type	Description	Required	Default	Options
CategoryId	`Int32`	Category Id	Optional
ChallengeId	`Guid`	Ideation id	Optional
ContentIds	`String`	Comma separated list of ContentIds. Used to limit to a specific set of ideas as well as sort order if SoryBy is set to ContentIdsOrder.	Optional
GroupId	`Int32`	Group Id	Optional
IncludeSubGroups	`Boolean`	Include Sub Groups	Optional	False
IsClosed	`Nullable of Boolean`	Allows inclusion or exclusion of ideas in a closed state.	Optional
MaximumVoteCount	`Int32`	Maximum number of votes an idea can have to be returned.	Optional
MinimumVoteCount	`Int32`	Minimum number of votes an idea must have to be returned.	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
QueryType	`String`	'topquality' ignores other query options and sorts by idea quality score descending	Optional	active	active, all, myideas, myvotes, topquality
ReleasesVotes	`Nullable of Boolean`	Allows inclusion or exlusion of ideas in statuses where votes are released	Optional
SortBy	`String`	Sort By	Optional	score	contentidsorder, date, lastupdateddate, novotes, score, topic, totalvotes, yesvotes
SortOrder	`String`	Sort Order	Optional	descending	ascending, descending
Status	`String`	Status	Optional
UserId	`Int32`	UserId of Idea Author, used for 'myideas' query type	Optional

Returns

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

Update

Updates an Idea

Velocity

#set($ideaResponse = $telligentIdeas_v1_ideas.Update($ideaId, "%{ CategoryId = $categoryIdArg, ChallengeId = $challengeIdArg, Description = $descriptionArg, Name = $nameArg, Status = $statusArg, StatusNotes = $statusNotesArg, Tags = $tagsArg, UrlKey = $urlKeyArg }"))

JavaScript

var ideaResponse = telligentIdeas_v1_ideas.Update(ideaId, { CategoryId: categoryIdArg, ChallengeId: challengeIdArg, Description: descriptionArg, Name: nameArg, Status: statusArg, StatusNotes: statusNotesArg, Tags: tagsArg, UrlKey: urlKeyArg });

Parameters

Name	Type	Description	Required
ideaId	`Guid`	Idea Id	Required
CategoryId	`Int32`	Category Id	Optional
ChallengeId	`Guid`	Ideation id	Optional
Description	`String`	Description	Optional
Name	`String`	Name	Optional
Status	`String`	Status of idea. OBSOLETE IN 10.2: Use IdeaStatus endpoint instead.	Optional
StatusNotes	`String`	Notes on idea status. OBSOLETE IN 11.0: Use IdeaStatus endpoint instead.	Optional
Tags	`String`	Comma delimited list of tags	Optional
UrlKey	`String`	Unique url string for idea	Optional

Returns

[[Idea Script API Type|Idea]]

UpDownVoteUI

UpDownVoteUI Overload 1

Outputs the Up/Down Voting for an Idea

Velocity

#set($stringResponse = $telligentIdeas_v1_ideas.UpDownVoteUI($id))

JavaScript

var stringResponse = telligentIdeas_v1_ideas.UpDownVoteUI(id);

Parameters

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

UpDownVoteUI Overload 2

Outputs the Up/Down Voting for an Idea

Velocity

#set($stringResponse = $telligentIdeas_v1_ideas.UpDownVoteUI($id, "%{ LoginWithReturnUrl = $loginWithReturnUrlArg, ReadOnly = $readOnlyArg }"))

JavaScript

var stringResponse = telligentIdeas_v1_ideas.UpDownVoteUI(id, { LoginWithReturnUrl: loginWithReturnUrlArg, ReadOnly: readOnlyArg });

Parameters

Name	Type	Description	Required
id	`Guid`	Id	Required
LoginWithReturnUrl	`Boolean`	For anonymous users, should login url contain a return url	Optional
ReadOnly	`Boolean`	false	Optional

Returns

String