Enables scripted content fragments to use Ideas
Properties
Name | Type | Description | Default | Options |
---|---|---|---|---|
ContentTypeId | Guid | Ideas content type identifier | ||
Current | Idea | Current contextual idea |
Methods
Create
Creates an idea
Usage
#set($ideaResponse = $telligentIdeas_v1_ideas.Create($challengeId, $name, $description, "%{CategoryId = $categoryIdArg, Status = $statusArg, StatusNotes = $statusNotesArg, Tags = $tagsArg, UrlKey = $urlKeyArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
challengeId | Guid | Challenge Id | Required | ||
name | string | Name | Required | ||
description | string | Description | Required | ||
CategoryId | int | 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 |
Return Type
Delete
Deletes an Idea
Usage
#set($additionalInfoResponse = $telligentIdeas_v1_ideas.Delete($id))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
id | Guid | Content Id | Required |
Return Type
Get
Gets an Idea
Usage
#set($ideaResponse = $telligentIdeas_v1_ideas.Get($id))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
id | Guid | Idea Id | Required |
Return Type
IncrementViewCount
Increments the views for the specified idea.
Usage
$telligentIdeas_v1_ideas.IncrementViewCount($ideaId)
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
ideaId | Guid | Idea Id | Required |
List
Lists Ideas
Usage
#set($pagedListResponse = $telligentIdeas_v1_ideas.List("%{CategoryId = $categoryIdArg, ChallengeId = $challengeIdArg, ContentIds = $contentIdsArg, GroupId = $groupIdArg, IncludeSubGroups = $includeSubGroupsArg, IsClosed = $isClosedArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, QueryType = $queryTypeArg, ReleasesVotes = $releasesVotesArg, SortBy = $sortByArg, SortOrder = $sortOrderArg, Status = $statusArg, UserId = $userIdArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
CategoryId | int | 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 | int | Group Id | Optional | ||
IncludeSubGroups | bool | Include Sub Groups | Optional | False | |
IsClosed | bool? | Allows inclusion or exclusion of ideas in a closed state. | Optional | ||
PageIndex | int | Specify the page number of paged results to return. Zero-based index. | Optional | 0 | |
PageSize | int | 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 | bool? | 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 | int | UserId of Idea Author, used for 'myideas' query type | Optional |
Return Type
Update
Updates an Idea
Usage
#set($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 | Default | Options |
---|---|---|---|---|---|
ideaId | Guid | Idea Id | Required | ||
CategoryId | int | 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 |
Return Type
UpDownVoteUI
Outputs the Up/Down Voting for an Idea
Usage
#set($stringResponse = $telligentIdeas_v1_ideas.UpDownVoteUI($id))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
id | Guid | Id | Required |
Return Type
string
UpDownVoteUI
Outputs the Up/Down Voting for an Idea
Usage
#set($stringResponse = $telligentIdeas_v1_ideas.UpDownVoteUI($id, "%{LoginWithReturnUrl = $loginWithReturnUrlArg, ReadOnly = $readOnlyArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
id | Guid | Id | Required | ||
LoginWithReturnUrl | bool | For anonymous users, should login url contain a return url | Optional | ||
ReadOnly | bool | false | Optional |
Return Type
string