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": "3a5112df-21d8-4372-bdf7-86ee1cc63e8a", "IdeationCategoryKeys": [ "45e88f46-0560-407f-b603-f29b43c5c537", "5fc6954a-5878-4167-96eb-3794a53cef20" ] }
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>45e88f46-0560-407f-b603-f29b43c5c537</d2p1:guid> <d2p1:guid>5fc6954a-5878-4167-96eb-3794a53cef20</d2p1:guid> </IdeationCategoryKeys> <IdeationKey>3a5112df-21d8-4372-bdf7-86ee1cc63e8a</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. |
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": "b181c5f6-cbaf-40e4-8684-f76b73e06a5e", "Title": "sample string 2", "Description": "sample string 3", "LinkToViewIdea": "sample string 4", "Status": null, "Categories": null, "TotalUpvotes": 5, "TotalDownvotes": 6, "HasOfficialComment": true, "Author": { "LinkToProfile": "sample string 1", "PictureUrl": "sample string 2", "ContactKey": "3c555d7f-c064-4bf9-bbe7-f09286c662bf", "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": "2024-09-08T00:58:59.5934745Z", "UpdatedByContactKey": "fab9ac59-bdd5-402b-b080-f79a1fbb4b30", "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": "2024-09-08T00:58:59.5934745Z" }, "IsAnonymous": true, "CreatedOn": "2024-09-08T00:58:59.5934745Z", "UpdatedOn": "2024-09-08T00:58:59.5934745Z", "AttachmentURLs": null }
application/xml
Sample not available.
text/xml
Sample not available.