POST api/v2.0/Ideation/AddIdeaCategories
Add categories to an idea.
Request Information
URI Parameters
None.
Body Parameters
SetIdeaCategoriesRequestName | Description | Type | Additional information |
---|---|---|---|
IdeationKey |
Key of the idea. |
globally unique identifier |
Required |
IdeationCategoryKeys |
Category keys to add to the idea. |
Collection of globally unique identifier |
Required |
Request Formats
application/json, text/json
{ "IdeationKey": "ca8bd6e8-44f4-468e-ae8b-acd4a9f1792e", "IdeationCategoryKeys": [ "99e19276-06f7-4c4d-9396-586b956d718e", "f1250738-57c0-4742-97b2-d115e02d68fd" ] }
application/xml, text/xml
<SetIdeaCategoriesRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise.Ideation"> <IdeationCategoryKeys xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>99e19276-06f7-4c4d-9396-586b956d718e</d2p1:guid> <d2p1:guid>f1250738-57c0-4742-97b2-d115e02d68fd</d2p1:guid> </IdeationCategoryKeys> <IdeationKey>ca8bd6e8-44f4-468e-ae8b-acd4a9f1792e</IdeationKey> </SetIdeaCategoriesRequest>
Response Information
Resource Description
Idea updated
IdeaDetailsName | Description | Type | Additional information |
---|---|---|---|
IdeationKey |
Unique identifier of the idea. |
globally unique identifier |
None. |
Title |
Title of the idea. |
string |
None. |
Description |
Description of the idea. |
string |
None. |
LinkToViewIdea |
Direct link to view the idea on the main microsite. |
string |
None. |
Status |
Object containing information about the status of the idea. |
IdeaStatus |
None. |
Community |
The community the idea has been associated to. If null or doesn't exist (i.e. the idea is not associated to any community), the idea is considered to be a site-wide idea. |
Community |
None. |
Categories |
All categories the idea has been associated to. |
Collection of IdeaCategory |
None. |
TotalUpvotes |
Number of upvotes. |
integer |
None. |
TotalDownvotes |
Number of downvotes. |
integer |
None. |
HasOfficialComment |
True if this idea has an official comment from an admin. |
boolean |
None. |
Author |
Information about the author of the idea. |
ContactConcise |
None. |
IsAnonymous |
True if the idea was submitted anonymously. |
boolean |
None. |
CreatedOn |
DateTime the idea was created. |
date |
None. |
UpdatedOn |
Most recent DateTime the idea was updated. |
date |
None. |
AttachmentURLs |
Temporary URLs to view or download any attachments associated with the idea. |
Collection of IdeaAttachment |
None. |
Response Formats
application/json, text/json
{ "IdeationKey": "6a8a9ffc-a096-469c-b375-c05be2e09652", "Title": "sample string 2", "Description": "sample string 3", "LinkToViewIdea": "sample string 4", "Status": null, "Community": null, "Categories": null, "TotalUpvotes": 5, "TotalDownvotes": 6, "HasOfficialComment": true, "Author": { "LinkToProfile": "sample string 1", "PictureUrl": "sample string 2", "ContactKey": "c5ba0b68-2950-4a6c-b888-2392940bafec", "FirstName": "sample string 4", "LastName": "sample string 5", "DisplayName": "sample string 6", "EmailAddress": "sample string 7", "ContactStatusCode": "sample string 8", "PrefixCode": "sample string 9", "UpdatedOn": "2025-05-20T14:14:35.5620759Z", "UpdatedByContactKey": "c4d15533-f398-41e8-b787-e96bbf565cbb", "CompanyName": "sample string 12", "CompanyTitle": "sample string 13", "SuffixCode": "sample string 14", "Designation": "sample string 15", "LegacyContactKey": "sample string 16", "InformalName": "sample string 17", "MiddleName": "sample string 18", "IsCompany": true, "CompanyLegacyContactKey": "sample string 20", "AMSDirectoryOptOut": true, "HLDirectoryOptOut": true, "HLContactMeOptOut": true, "LargePictureUrl": "sample string 24", "AgreedToTermsDateTime": "2025-05-20T14:14:35.5620759Z" }, "IsAnonymous": true, "CreatedOn": "2025-05-20T14:14:35.5620759Z", "UpdatedOn": "2025-05-20T14:14:35.5620759Z", "AttachmentURLs": null }
application/xml
Sample not available.
text/xml
Sample not available.