Enables scripted content fragments to use Idea Statuses
Methods
Create
Create a Status
Usage
#set($statusResponse = $telligentIdeas_v1_statuses.Create("%{Description = $descriptionArg, IsDefault = $isDefaultArg, Name = $nameArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
Description | string | Status Description | Optional | ||
IsDefault | bool | Set Status as Default | Optional | ||
Name | string | Status Name | Optional |
Return Type
Delete
Deletes a Status
Usage
#set($additionalInfoResponse = $telligentIdeas_v1_statuses.Delete($key, $reassignKey))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
key | string | Key | Required | ||
reassignKey | string | Reassign Key | Required |
Return Type
Get
Gets a Status
Usage
#set($statusResponse = $telligentIdeas_v1_statuses.Get($key))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
key | string | Key | Required |
Return Type
List
Returns a List of Statuses
Usage
#set($apiListResponse = $telligentIdeas_v1_statuses.List())
Return Type
Update
Update a Status
Usage
#set($statusResponse = $telligentIdeas_v1_statuses.Update($key, "%{Description = $descriptionArg, IsDefault = $isDefaultArg, Name = $nameArg, ScoreValue = $scoreValueArg, SortOrder = $sortOrderArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
key | string | Key | Required | ||
Description | string | Status Description | Optional | ||
IsDefault | bool | Set Status as Default | Optional | ||
Name | string | Status Name | Optional | ||
ScoreValue | int | Set Status score value | Optional | ||
SortOrder | int | Set Status sort order | Optional |