GET api/v2.0/Ideation/GetIdeasByStatus?ideationStatusKey={ideationStatusKey}&afterIdeaKey={afterIdeaKey}&beforeIdeaKey={beforeIdeaKey}&numberToReturn={numberToReturn}

Returns a specified number of ideas in a particular status, optionally using the afterIdeaKey or beforeIdeaKey as a starting point. Ideas are ordered by creation date, most recent to least recent. If both keys are included, afterIdeaKey will take precedence.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
ideationStatusKey

Unique identifier for the status to filter ideas on.

globally unique identifier

Required

afterIdeaKey

The ideationKey to use as a starting point, returning the next set of ideas after this idea. This idea will not be included in the response.

globally unique identifier

None.

beforeIdeaKey

The ideationKey to use as a starting point, returning the previous set of ideas before this idea. This idea will not be included in the response. If both keys are included, afterIdeaKey will take precedence.

globally unique identifier

None.

numberToReturn

Number of ideas to return. Default is 10, max is 50.

integer

Default value is 10

Body Parameters

None.

Response Information

Resource Description

This endpoint will return ideas in the same order, most recently created to least recently created.

PagedIdeaList
NameDescriptionTypeAdditional information
Ideas

The set of ideas specified in this particular paginated set.

Collection of IdeaDetails

None.

HasMoreIdeas

Whether or not there are more ideas that continue on after this paginated set.

boolean

None.

Next

Specifies a relative path to select the next set of paginated ideas based on the current set. Empty if there are no ideas older then the last idea in the current set.

string

None.

Previous

Specifies a relative path to select the previous set of paginated ideas based on the current set. Empty if there are no ideas newer than the first idea in the current set.

string

None.

Response Formats

application/json, text/json

Sample:

Sample not available.