Exposes Idea Categories to widgets
Methods
Create
Create a Category for a specific Ideation
Usage
#set($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 |
Return Type
Delete
Delete a specific Category
Usage
#set($additionalInfoResponse = $telligentIdeas_v1_ideaCategories.Delete($ideationId, $id, "%{ReassignCategoryId = $reassignCategoryIdArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
ideationId | Guid | Ideation Id | Required | ||
id | int | Category Id | Required | ||
ReassignCategoryId | int | Optional. Specify a new category to which to reassign items from the deleted category | Optional |
Return Type
Get
Get a specific Category
Usage
#set($ideaCategoryResponse = $telligentIdeas_v1_ideaCategories.Get($ideationId, $id))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
ideationId | Guid | Ideation Id | Required | ||
id | int | Category Id | Required |
Return Type
List
List Idea Categories for an Ideation
Usage
#set($apiListResponse = $telligentIdeas_v1_ideaCategories.List($ideationId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
ideationId | Guid | Ideation Id | Required |
Return Type
Update
Update a Category
Usage
#set($ideaCategoryResponse = $telligentIdeas_v1_ideaCategories.Update($ideationId, $id, "%{Name = $nameArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
ideationId | Guid | Ideation Id | Required | ||
id | int | Category Id | Required | ||
Name | string | Optional. New name for the category. | Optional |