Exposes Idea Status Changes to widgets
Properties
Name | Access | Type | Description |
---|---|---|---|
Current | Read | IdeaStatus | Current |
Methods
Create
Create Overload 1
Add a new status to an idea.
Velocity
#set($ideaStatusResponse = $telligentIdeas_v1_ideaStatuses.Create($ideaId))
JavaScript
var ideaStatusResponse = telligentIdeas_v1_ideaStatuses.Create(ideaId);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
ideaId | Guid | Idea Id | Required |
Create Overload 2
Add a new status to an idea.
Velocity
#set($ideaStatusResponse = $telligentIdeas_v1_ideaStatuses.Create($ideaId, "%{ Note = $noteArg, Status = $statusArg }"))
JavaScript
var ideaStatusResponse = telligentIdeas_v1_ideaStatuses.Create(ideaId, { Note: noteArg, Status: statusArg });
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
ideaId | Guid | Idea Id | Required | ||
options | Options | Set of optional parameters including: | 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 |
Returns
Delete
Delete a specific status history entry.
Velocity
$telligentIdeas_v1_ideaStatuses.Delete($ideaId, $ideaStatusId)
JavaScript
telligentIdeas_v1_ideaStatuses.Delete(ideaId, ideaStatusId);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
ideaId | Guid | Idea Id | Required | ||
ideaStatusId | Int32 | Idea Status Id | Required |
Returns
NothingGet
Velocity
#set($ideaStatusResponse = $telligentIdeas_v1_ideaStatuses.Get($ideaId, $ideaStatusId))
JavaScript
var ideaStatusResponse = telligentIdeas_v1_ideaStatuses.Get(ideaId, ideaStatusId);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
ideaId | Guid | Idea Id | Required | ||
ideaStatusId | Int32 | Idea Status Id | Required |
Returns
List
List Overload 1
Returns the status history for a specified Idea.
Velocity
#set($pagedListResponse = $telligentIdeas_v1_ideaStatuses.List($ideaId))
JavaScript
var pagedListResponse = telligentIdeas_v1_ideaStatuses.List(ideaId);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
ideaId | Guid | Idea Id | Required |
List Overload 2
Returns the status history for a specified Idea.
Velocity
#set($pagedListResponse = $telligentIdeas_v1_ideaStatuses.List($ideaId, "%{ PageIndex = $pageIndexArg, PageSize = $pageSizeArg, SortOrder = $sortOrderArg }"))
JavaScript
var pagedListResponse = telligentIdeas_v1_ideaStatuses.List(ideaId, { PageIndex: pageIndexArg, PageSize: pageSizeArg, SortOrder: sortOrderArg });
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
ideaId | Guid | Idea Id | Required | ||
options | Options | Set of optional parameters including: | Required | ||
PageIndex | Int32 | Which page of results to return | Optional | 0 | |
PageSize | Int32 | Number of results to return | Optional | 20 | |
SortOrder | String | Order in which to display the results, sorted by date. Options: ascending, descending | Optional | descending |
Returns
Update
Update an existing status in an idea's history.
Velocity
#set($ideaStatusResponse = $telligentIdeas_v1_ideaStatuses.Update($ideaId, $ideaStatusId, "%{ Note = $noteArg }"))
JavaScript
var ideaStatusResponse = telligentIdeas_v1_ideaStatuses.Update(ideaId, ideaStatusId, { Note: noteArg });
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
ideaId | Guid | Idea Id | Required | ||
ideaStatusId | Int32 | Idea Status Id | Required | ||
options | Options | Set of optional parameters including: | Required | ||
Note | String | Custom text field to accompany status. | Optional |