Exposes Idea Status Changes to widgets
Properties
Name | Type | Description | Default | Options |
---|---|---|---|---|
Current | IdeaStatus |
Methods
Create
Add a new status to an idea.
Usage
#set($ideaStatusResponse = $telligentIdeas_v1_ideaStatuses.Create($ideaId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
ideaId | Guid | Idea Id | Required |
Return Type
Create
Add a new status to an idea.
Usage
#set($ideaStatusResponse = $telligentIdeas_v1_ideaStatuses.Create($ideaId, "%{Note = $noteArg, Status = $statusArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
ideaId | Guid | Idea Id | Required | ||
Note | string | Custom text field to accompany status. | Optional | ||
Status | string | Identifies the current status of the idea. Valid choices are managed by Statuses API. | Optional |
Return Type
Delete
Delete a specific status history entry.
Usage
$telligentIdeas_v1_ideaStatuses.Delete($ideaId, $ideaStatusId)
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
ideaId | Guid | Idea Id | Required | ||
ideaStatusId | int | Idea Status Id | Required |
Get
Usage
#set($ideaStatusResponse = $telligentIdeas_v1_ideaStatuses.Get($ideaId, $ideaStatusId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
ideaId | Guid | Idea Id | Required | ||
ideaStatusId | int | Idea Status Id | Required |
Return Type
List
Returns the status history for a specified Idea.
Usage
#set($pagedListResponse = $telligentIdeas_v1_ideaStatuses.List($ideaId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
ideaId | Guid | Idea Id | Required |
Return Type
List
Returns the status history for a specified Idea.
Usage
#set($pagedListResponse = $telligentIdeas_v1_ideaStatuses.List($ideaId, "%{PageIndex = $pageIndexArg, PageSize = $pageSizeArg, SortOrder = $sortOrderArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
ideaId | Guid | Idea Id | Required | ||
PageIndex | int | Which page of results to return | Optional | 0 | |
PageSize | int | Number of results to return | Optional | 20 | |
SortOrder | string | Order in which to display the results, sorted by date. Options: ascending, descending | Optional | descending |
Return Type
Update
Update an existing status in an idea's history.
Usage
#set($ideaStatusResponse = $telligentIdeas_v1_ideaStatuses.Update($ideaId, $ideaStatusId, "%{Note = $noteArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
ideaId | Guid | Idea Id | Required | ||
ideaStatusId | int | Idea Status Id | Required | ||
Note | string | Custom text field to accompany status. | Optional |