GET api/v2.0/Ideation/IdeaDetails?ideationKey={ideationKey}

Gets the details of an idea.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
ideationKey

Unique identifier for the idea to be retrieved.

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

Detailed information about the idea specified.

IdeaDetails
NameDescriptionTypeAdditional information
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

Sample:
{
  "Title": "sample string 1",
  "Description": "sample string 2",
  "LinkToViewIdea": "sample string 3",
  "Status": null,
  "Categories": null,
  "TotalUpvotes": 4,
  "TotalDownvotes": 5,
  "HasOfficialComment": true,
  "Author": {
    "LinkToProfile": "sample string 1",
    "PictureUrl": "sample string 2",
    "ContactKey": "3c80661d-4143-4870-83ed-8970cc3e952f",
    "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-05-23T17:26:08.410892Z",
    "UpdatedByContactKey": "440f70a5-853c-4aea-96fb-e7cb8c5cd9bc",
    "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-05-23T17:26:08.410892Z"
  },
  "IsAnonymous": true,
  "CreatedOn": "2024-05-23T17:26:08.410892Z",
  "UpdatedOn": "2024-05-23T17:26:08.410892Z",
  "AttachmentURLs": null
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.