POST api/v2.0/Ideation/Post
Create a new idea.
Request Information
URI Parameters
None.
Body Parameters
New idea to submit
NewIdeaRequestName | Description | Type | Additional information |
---|---|---|---|
Title |
Title of the idea. Maximum length is 100 characters. |
string |
Required |
Description |
Description of the idea. |
string |
Required |
IdeationStatusKey |
Key for the status of the idea. Statuses are configurable on a per-site basis, the list of available statuses can be retrieved from the getStatuses endpoint. |
globally unique identifier |
Required |
IdeationCategoryKeys |
Keys for the categories the idea is associated to. Categories are configurable on a per-site basis, the list of available categories can be retrieved from the getCategories endpoint. |
Collection of globally unique identifier |
None. |
IsAnonymous |
True if the idea is being submitted anonymously. |
boolean |
None. |
Request Formats
application/json, text/json
{ "Title": "sample string 1", "Description": "sample string 2", "IdeationStatusKey": "a9b8c948-e3c7-4647-8840-d0765d94a275", "IdeationCategoryKeys": [ "6b39978d-16c4-4fe4-b1c5-60a6d55163b3", "53888f6c-23df-4977-8278-465e532afa01" ], "IsAnonymous": true }
application/xml, text/xml
<NewIdeaRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise.Ideation"> <Description>sample string 2</Description> <IdeationCategoryKeys xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>6b39978d-16c4-4fe4-b1c5-60a6d55163b3</d2p1:guid> <d2p1:guid>53888f6c-23df-4977-8278-465e532afa01</d2p1:guid> </IdeationCategoryKeys> <IdeationStatusKey>a9b8c948-e3c7-4647-8840-d0765d94a275</IdeationStatusKey> <IsAnonymous>true</IsAnonymous> <Title>sample string 1</Title> </NewIdeaRequest>
Response Information
Resource Description
Submitted idea
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": "36107372-9b4e-4e17-a380-44556d275bcf", "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": "f1713463-ce3c-4320-ae92-3fd594ed5fd8", "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-10-29T18:00:17.515226Z", "UpdatedByContactKey": "50c683a3-90ec-4a12-92c7-71b7973c5920", "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-10-29T18:00:17.515226Z" }, "IsAnonymous": true, "CreatedOn": "2024-10-29T18:00:17.515226Z", "UpdatedOn": "2024-10-29T18:00:17.515226Z", "AttachmentURLs": null }
application/xml
Sample not available.
text/xml
Sample not available.