Enables scripted content fragments to use Idea Statuses
Methods
Create
Create a Status
Velocity
#set($statusResponse = $telligentIdeas_v1_statuses.Create("%{ Description = $descriptionArg, IsClosed = $isClosedArg, IsDefault = $isDefaultArg, Name = $nameArg, ReleasesVotes = $releasesVotesArg, ScoreValue = $scoreValueArg, SortOrder = $sortOrderArg }"))JavaScript
var statusResponse = telligentIdeas_v1_statuses.Create({ Description: descriptionArg, IsClosed: isClosedArg, IsDefault: isDefaultArg, Name: nameArg, ReleasesVotes: releasesVotesArg, ScoreValue: scoreValueArg, SortOrder: sortOrderArg });Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| options | Options | Set of optional parameters including: | Required | ||
| Description | String | Status Description | Optional | ||
| IsClosed | Boolean | Is Closed | Optional | ||
| IsDefault | Boolean | Set Status as Default | Optional | ||
| Name | String | Status Name | Optional | ||
| ReleasesVotes | Boolean | Ideas in this status do not count user votes against their running total for the ideation. | Optional | ||
| ScoreValue | Int32 | Set Status score value | Optional | ||
| SortOrder | Int32 | Set Status sort order | Optional |
Returns
Delete
Deletes a Status
Velocity
#set($additionalInfoResponse = $telligentIdeas_v1_statuses.Delete($key, $reassignKey))
JavaScript
var additionalInfoResponse = telligentIdeas_v1_statuses.Delete(key, reassignKey);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| key | String | Key | Required | ||
| reassignKey | String | Reassign Key | Required |
Returns
Get
Gets a Status
Velocity
#set($statusResponse = $telligentIdeas_v1_statuses.Get($key))
JavaScript
var statusResponse = telligentIdeas_v1_statuses.Get(key);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| key | String | Key | Required |
Returns
List
Returns a List of Statuses
Velocity
#set($apiListResponse = $telligentIdeas_v1_statuses.List())
JavaScript
var apiListResponse = telligentIdeas_v1_statuses.List();
Returns
Update
Update a Status
Velocity
#set($statusResponse = $telligentIdeas_v1_statuses.Update($key, "%{ Description = $descriptionArg, IsClosed = $isClosedArg, IsDefault = $isDefaultArg, Name = $nameArg, ReleasesVotes = $releasesVotesArg, ScoreValue = $scoreValueArg, SortOrder = $sortOrderArg }"))JavaScript
var statusResponse = telligentIdeas_v1_statuses.Update(key, { Description: descriptionArg, IsClosed: isClosedArg, IsDefault: isDefaultArg, Name: nameArg, ReleasesVotes: releasesVotesArg, ScoreValue: scoreValueArg, SortOrder: sortOrderArg });Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| key | String | Key | Required | ||
| options | Options | Set of optional parameters including: | Required | ||
| Description | String | Status Description | Optional | ||
| IsClosed | Boolean | Is Closed | Optional | ||
| IsDefault | Boolean | Set Status as Default | Optional | ||
| Name | String | Status Name | Optional | ||
| ReleasesVotes | Boolean | Ideas in this status do not count user votes against their running total for the ideation. | Optional | ||
| ScoreValue | Int32 | Set Status score value | Optional | ||
| SortOrder | Int32 | Set Status sort order | Optional |