Developers

Ideas in a Pipeline

Retrieves the ideas in a pipeline contains all information to review an idea which includes:

  • Idea information see Idea Profile.
  • Private comments
  • Drop down fields, with the possibility of containing
    • Choices
  • Open text fields
  • Rating fields
    • Rating

GET: /api/pipeline/ideas/[id number of pipeline]

this API endpoint also requires valid X-On-Behalf-Of headers. See here for more information.

Note, although ideas in a pipeline may be viewed by all Brainstorm users, ideas may only be reviewed by a pipeline review team member. As a result, private comments, drop down fields, open text fields, and ratings wil only be displayed of the reqest is made on behalf of a user on the challenge review team.

This API endpoint is capable of pagination. Note the presence of the following elements: 

<NumberOfResults>2</NumberOfResults>
<Page>0</Page>
<TotalResults>59</TotalResults>

For more information on paged results, see the Query Strings that manipulate responses section on the API overview page. 


        
{
    "Data": [
        {
            "DropDownFields": [
                {
                    "Id": 1680,
                    "Label": "Point of Contact",
                    "Position": 0,
                    "Choices": [
                        {
                            "Label": "Dan Jackson",
                            "Position": 0,
                            "Value": "881"
                        }
                    ],
                    "Value": null
                }
            ],
            "Idea": {
                "Id": 7716,
                "AvgRatingRounded": 0,
                "BusinessUnitName": "Consumer: Personal Finance",
                "CommentCount": 0,
                "PunchLine": "API Test idea 10/7/2011 10:27:29 AM",
                "ScoreRecent": 0,
                "StatusName": "Just an idea, not working on it",
                "SubmittedOn": "/Date(1318008449000-0700)/",
                "Submitter": {
                    "Id": 18003,
                    "DisplayName": "Dan Jackson",
                    "EmailWork": "dan_jackson@intuit.com",
                    "Location": "0102184, Mountain View, CA",
                    "Phone": "",
                    "PhotoExists": false,
                    "PhotoUrl_36x36": "http://localhost.localhost/Images/photo_none_small.jpg",
                    "Title": "SW Engineer 2"
                },
                "TotalRatings": 0,
                "Comments": [],
                "Tabs": [
                    {
                        "DocumentParts": [],
                        "LinkParts": [],
                        "Name": "Main",
                        "Notes": [
                            {
                                "Id": 18251,
                                "Body": "This is the description",
                                "Title": "Description"
                            }
                        ],
                        "Position": 1000,
                        "TodoListParts": []
                    }
                ],
                "Team": [
                    {
                        "Id": 18003,
                        "DisplayName": "Dan Jackson",
                        "EmailWork": "dan_jackson@intuit.com",
                        "Location": "0102184, Mountain View, CA",
                        "Phone": "",
                        "PhotoExists": false,
                        "PhotoUrl_36x36": "http://localhost.localhost/Images/photo_none_small.jpg",
                        "Title": "SW Engineer 2"
                    }
                ]
            },
            "OpenTextFields": [
                {
                    "Id": 1681,
                    "Label": "Next Action",
                    "Position": 1,
                    "Value": ""
                }
            ],
            "PrivateComments": [
                {
                    "Author": {
                        "DisplayName": "Dan Jackson",
                        "EmailWork": "dan_jackson@intuit.com",
                        "PhotoExists": false,
                        "PhotoUrl_36x36": "/Images/photo_none_icon.jpg"
                    },
                    "Body": "
Spider pig! Spider pig! Doing whatever a spider pig does!!
\n",
                    "ByIdeaTeamMember": true,
                    "Id": 15753,
                    "LikeCount": 0,
                    "PostTime": "/Date(1318033650000-0700)/",
                    "Replies": []
                }
            ],
            "RatingFields": [
                {
                    "Id": 1682,
                    "Label": "Overall Rating",
                    "Position": 0,
                    "AverageRating": null,
                    "Ratings": [
                        {
                            "Label": "Well below average",
                            "Rating": 1,
                            "Reviewers": []
                        },
                        {
                            "Label": "Below average",
                            "Rating": 2,
                            "Reviewers": []
                        },
                        {
                            "Label": "Average",
                            "Rating": 3,
                            "Reviewers": []
                        },
                        {
                            "Label": "Above average",
                            "Rating": 4,
                            "Reviewers": []
                        },
                        {
                            "Label": "Well above average",
                            "Rating": 5,
                            "Reviewers": []
                        }
                    ]
                }
            ]
        }
    ],
    "NumberOfResults": 1,
    "Page": 0,
    "TotalResults": 1
}

Explaination of pagination elements

  • The <NumberOfResults> value designates how many results are contained in the response.
  • The <Page> value designates how many results were skipped
  • The <TotalResults> value designates how many total results exist.