telligentIdeas_v1_statuses Script API

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

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

Enables scripted content fragments to use Idea Statuses

Create
Delete
Get
List
Update

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
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

[[Status Script API Type|Status]]

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

[[AdditionalInfo Script API Type|AdditionalInfo]]

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

[[Status Script API Type|Status]]

List

Returns a List of Statuses

Velocity

#set($apiListResponse = $telligentIdeas_v1_statuses.List())

JavaScript

var apiListResponse = telligentIdeas_v1_statuses.List();

Returns

[[ApiList Script API Type|ApiList]] of [[Status Script API Type|Status]]

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
key	`String`	Key	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

[[Status Script API Type|Status]]