POST api/v2.0/Ideation/UpdateIdeaStatus
Update the status of an idea.
Request Information
URI Parameters
None.
Body Parameters
Update idea request object
UpdateIdeaStatusRequestName | Description | Type | Additional information |
---|---|---|---|
IdeationKey |
Unique identifier for the idea to be updated. |
globally unique identifier |
Required |
IdeationStatusKey |
Unique identifier of the status that will applied to the idea. |
globally unique identifier |
Required |
Request Formats
application/json, text/json
{ "IdeationKey": "baab06c2-e72d-4dd5-ba34-d94e7d2485c8", "IdeationStatusKey": "c0c206cd-91ec-46d3-94d8-f19aa00172ef" }
application/xml, text/xml
<UpdateIdeaStatusRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise.Ideation"> <IdeationKey>baab06c2-e72d-4dd5-ba34-d94e7d2485c8</IdeationKey> <IdeationStatusKey>c0c206cd-91ec-46d3-94d8-f19aa00172ef</IdeationStatusKey> </UpdateIdeaStatusRequest>
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": "99820292-ad73-4687-b53d-d4a3a6d35b5a", "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": "79fcf458-d97a-4ffc-a4f2-4b0bb620cfb2", "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-01-15T07:28:08.2883314Z", "UpdatedByContactKey": "a9a3485c-b1e9-4680-8d9d-85dcb333cc8a", "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-01-15T07:28:08.2883314Z" }, "IsAnonymous": true, "CreatedOn": "2025-01-15T07:28:08.2883314Z", "UpdatedOn": "2025-01-15T07:28:08.2883314Z", "AttachmentURLs": null }
application/xml
Sample not available.
text/xml
Sample not available.