Exposes Idea Categories to widgets
Methods
Create
Create a Category for a specific Ideation
Velocity
#set($ideaCategoryResponse = $telligentIdeas_v1_ideaCategories.Create($ideationId, $name))
JavaScript
var ideaCategoryResponse = telligentIdeas_v1_ideaCategories.Create(ideationId, name);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
ideationId | Guid | Ideation Id | Required | ||
name | String | Plain text name of the category | Required |
Returns
Delete
Delete a specific Category
Velocity
#set($additionalInfoResponse = $telligentIdeas_v1_ideaCategories.Delete($ideationId, $id, "%{ ReassignCategoryId = $reassignCategoryIdArg }"))
JavaScript
var additionalInfoResponse = telligentIdeas_v1_ideaCategories.Delete(ideationId, id, { ReassignCategoryId: reassignCategoryIdArg });
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
ideationId | Guid | Ideation Id | Required | ||
id | Int32 | Category Id | Required | ||
options | Options | Set of optional parameters including: | Required | ||
ReassignCategoryId | Int32 | Optional. Specify a new category to which to reassign items from the deleted category | Optional |
Returns
Get
Get a specific Category
Velocity
#set($ideaCategoryResponse = $telligentIdeas_v1_ideaCategories.Get($ideationId, $id))
JavaScript
var ideaCategoryResponse = telligentIdeas_v1_ideaCategories.Get(ideationId, id);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
ideationId | Guid | Ideation Id | Required | ||
id | Int32 | Category Id | Required |
Returns
List
List Idea Categories for an Ideation
Velocity
#set($apiListResponse = $telligentIdeas_v1_ideaCategories.List($ideationId))
JavaScript
var apiListResponse = telligentIdeas_v1_ideaCategories.List(ideationId);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
ideationId | Guid | Ideation Id | Required |
Returns
Update
Update a Category
Velocity
#set($ideaCategoryResponse = $telligentIdeas_v1_ideaCategories.Update($ideationId, $id, "%{ Name = $nameArg }"))
JavaScript
var ideaCategoryResponse = telligentIdeas_v1_ideaCategories.Update(ideationId, id, { Name: nameArg });
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
ideationId | Guid | Ideation Id | Required | ||
id | Int32 | Category Id | Required | ||
options | Options | Set of optional parameters including: | Required | ||
Name | String | Optional. New name for the category. | Optional |