defaultheader

GET commentVote

Get data of one commentVote object.

Parameters

Parameters Detail
format
optional
Specifies returned data format
Accepted value: "json", "xml"

Resource Information

Authentication: See Access Permission

HTTP Methods: GET

Request URL Format: https://{api_domain}/api3/commentVote

Access Permission

Access to data varies based on system settings and requester roles. See Oauth 2.0 for details on authentication.

Private WebStorms: Requester must authenticate to get data.

Public WebStorms: No authentication required to get data.

Errors

  • Invalid object ID or you don't have access to this object

Example Request

  • Method: GET
  • Header: Authorization=Bearer 85f7b2462570acdde9a458ba6495b8763dcd040c
  • URL: https://example.brightidea.com/api3/commentVote/?comment_id=353AB424-4B74-4930-A395-168505083CAD

    {
        "commentVote_list": [
            {
                "comment_id": "353AB424-4B74-4930-A395-168505083CAD",
                "date_created": "2011-12-09 15:50:19.603",
                "type": "demote",
                "comment": {
                    "id": "353AB424-4B74-4930-A395-168505083CAD",
                    "date_created": "2011-12-09 15:43:11.137",
                    "text": "test comment",
                    "idea": {
                        "id": "94D1CA24-3CE7-4FA7-AF36-4CB06D259325",
                        "date_created": "2011-12-09 14:39:43.863",
                        "date_modified": "2011-12-09 14:39:43.863",
                        "title": "Friday Idea",
                        "description": "Today is Friday",
                        "visible": true,
                        "anonymous": false,
                        "idea_code": "D201",
                        "stage_id": null,
                        "step_id": null,
                        "campaign": {
                            "id": "CE640FD7-42AF-45A2-9137-D21D65B43AD2",
                            "name": "Going Green Challenge",
                            "description": "This campaign is for Going Green Challenge ",
                            "date_created": "2011-05-05 16:09:54.997",
                            "start_date": "2011-05-05 16:09:54.997",
                            "end_date": "2012-05-04 16:09:54.997"
                        }
                    }
                },
                "member": {
                    "id": "AB3A6BD3-B7AA-4FF9-906D-03178FE2C4F5",
                    "email": "jdoe@example.com",
                    "screen_name": "John Doe",
                    "first_name": "John",
                    "last_name": "Doe",
                    "job_title": "Sales",
                    "address": "123 fake street",
                    "phone": "(123) 456-789",
                    "mobile_phone": "(987) 654-3210",
                    "external_user_id": "",
                    "skills": "Selling Software",
                    "work_history": "Worked at sales.com",
                    "photo_url": "https://example.brightideatest.com/api3/file/047047BB-A376-45D2-8113-1C17ECAF21FE?format=binary&thumb_size=100",
                    "date_created": "2011-09-09 16:07:12.870",
                    "date_modified": "2013-09-26 09:41:35.583",
                    "active": true,
                    "photo_file_id": "047047BB-A376-45D2-8113-1C17ECAF21FE",
                    "department": "Sales"
                }
            },
            {
                "comment_id": "353AB424-4B74-4930-A395-168505083CAD",
                "date_created": "2011-12-09 15:43:15.527",
                "type": "promote",
                "comment": {
                    "id": "353AB424-4B74-4930-A395-168505083CAD",
                    "date_created": "2011-12-09 15:43:11.137",
                    "text": "test comment",
                    "idea": {
                        "id": "94D1CA24-3CE7-4FA7-AF36-4CB06D259325",
                        "date_created": "2011-12-09 14:39:43.863",
                        "date_modified": "2011-12-09 14:39:43.863",
                        "title": "Friday Idea",
                        "description": "Today is Friday",
                        "visible": true,
                        "anonymous": false,
                        "idea_code": "D201",
                        "stage_id": null,
                        "step_id": null,
                        "campaign": {
                            "id": "CE640FD7-42AF-45A2-9137-D21D65B43AD2",
                            "name": "Going Green Challenge",
                            "description": "This campaign is for Going Green Challenge ",
                            "date_created": "2011-05-05 16:09:54.997",
                            "start_date": "2011-05-05 16:09:54.997",
                            "end_date": "2012-05-04 16:09:54.997"
                        }
                    }
                },
                "member": {
                    "id": "DAE57893-36FD-4158-9F27-803775380D0B",
                    "email": "max.power@example.com",
                    "screen_name": "Max Power",
                    "first_name": "Max",
                    "last_name": "Power",
                    "job_title": "Safety Inspector",
                    "address": "742 Evergreen Terrace, Springfield, IL",
                    "phone": "(123)456-7890",
                    "mobile_phone": "(987)654-3210",
                    "external_user_id": "123",
                    "skills": "Boxer, Mascot, Astronaut, Baby proofer, Truck driver, Hippie, Plow Driver, Food Critic",
                    "work_history": "Conceptual Artist, Mayor, Country Western Manager, Garbage Commissioner, Mountain Climber",
                    "photo_url": "https://example.brightideatest.com/api3/file/3557DDBA-0671-4D0D-8FA4-70A211A5B959?format=binary&thumb_size=100",
                    "date_created": "2011-05-05 16:09:52.720",
                    "date_modified": "2013-12-12 15:33:54.090",
                    "active": true,
                    "photo_file_id": "3557DDBA-0671-4D0D-8FA4-70A211A5B959",
                    "department": "Safety Department"
                }
            }
        ],
        "stats": {
            "total": "2",
            "page_count": 1,
            "current_page": 1
        }
    }
    




LIST commentVote

Get data on a list of commentVote objects. Objects are order by created date descending by default.

On retrieving large set of data, requester should use pagination parameters such as page and page_size to manage multiple requests.

Parameters

Parameters Detail
comment_id
optional
Filter return by comment ID
Sample value: "11111111-1111-1111-1111-111111111111"
member_id
optional
Filter return by ID of commentVote submitter
Sample value: "11111111-1111-1111-1111-111111111111"
type
optional
Filter return by commentVote type
Accepted Value: "promote", "demote"
date_created
optional
Filter return by commentVote created date. Response contains all ideas created within the 24 hours of the specified date
Sample value: "12/06/2009"
page_size
optional
Specifies number of records returns per page. Default: 20. Minimum: 1. Maximum: 100
Sample value: 50
page
optional
Specifies which page of records to return. Default: 1. Minimum: 1. Maximum: {page_count}
Sample value: 5
order
optional
A SQL style string that specifies the order the records should return in.
Sample value: "date_created ASC, idea_id DESC".
Accepted attributes: "idea_id", "type", "date_created"
format
optional
Specifies returned data format
Accepted value: "json", "xml"

Resource Information

Authentication: See Access Permission for LIST commentVote

HTTP Methods: GET

Request URL Format: https://{api_domain}/api3/commentVote

Access Permission

Access to data varies base on system setting and requester roles. See Authentication for details on authentication.

Private WebStorms: Requester must authenticate to get data.

Public WebStorms: No authentication required to get data.

Errors

  • Invalid object ID or you don't have access to this object

Example Request

  • Method: GET
  • Header: Authorization=Bearer 85f7b2462570acdde9a458ba6495b8763dcd040c
  • URL: https://example.brightidea.com/api3/commentVote?page_size=2&page=4

     {
        "commentVote_list": [
            {
                "comment_id": "353AB424-4B74-4930-A395-168505083CAD",
                "date_created": "2011-12-09 15:50:19.603",
                "type": "demote",
                "comment": {
                    "id": "353AB424-4B74-4930-A395-168505083CAD",
                    "date_created": "2011-12-09 15:43:11.137",
                    "text": "test comment",
                    "idea": {
                        "id": "94D1CA24-3CE7-4FA7-AF36-4CB06D259325",
                        "date_created": "2011-12-09 14:39:43.863",
                        "date_modified": "2011-12-09 14:39:43.863",
                        "title": "Friday Idea",
                        "description": "Today is Friday",
                        "visible": true,
                        "anonymous": false,
                        "idea_code": "D201",
                        "stage_id": null,
                        "step_id": null,
                        "campaign": {
                            "id": "CE640FD7-42AF-45A2-9137-D21D65B43AD2",
                            "name": "Going Green Challenge",
                            "description": "This campaign is for Going Green Challenge ",
                            "date_created": "2011-05-05 16:09:54.997",
                            "start_date": "2011-05-05 16:09:54.997",
                            "end_date": "2012-05-04 16:09:54.997"
                        }
                    }
                },
                "member": {
                    "id": "AB3A6BD3-B7AA-4FF9-906D-03178FE2C4F5",
                    "email": "jdoe@example.com",
                    "screen_name": "John Doe",
                    "first_name": "John",
                    "last_name": "Doe",
                    "job_title": "Sales",
                    "address": "123 fake street",
                    "phone": "(123) 456-789",
                    "mobile_phone": "(987) 654-3210",
                    "external_user_id": "",
                    "skills": "Selling Software",
                    "work_history": "Worked at sales.com",
                    "photo_url": "https://example.brightideatest.com/api3/file/047047BB-A376-45D2-8113-1C17ECAF21FE?format=binary&thumb_size=100",
                    "date_created": "2011-09-09 16:07:12.870",
                    "date_modified": "2013-09-26 09:41:35.583",
                    "active": true,
                    "photo_file_id": "047047BB-A376-45D2-8113-1C17ECAF21FE",
                    "department": "Sales"
                }
            },
            {
                "comment_id": "353AB424-4B74-4930-A395-168505083CAD",
                "date_created": "2011-12-09 15:43:15.527",
                "type": "promote",
                "comment": {
                    "id": "353AB424-4B74-4930-A395-168505083CAD",
                    "date_created": "2011-12-09 15:43:11.137",
                    "text": "test comment",
                    "idea": {
                        "id": "94D1CA24-3CE7-4FA7-AF36-4CB06D259325",
                        "date_created": "2011-12-09 14:39:43.863",
                        "date_modified": "2011-12-09 14:39:43.863",
                        "title": "Friday Idea",
                        "description": "Today is Friday",
                        "visible": true,
                        "anonymous": false,
                        "idea_code": "D201",
                        "stage_id": null,
                        "step_id": null,
                        "campaign": {
                            "id": "CE640FD7-42AF-45A2-9137-D21D65B43AD2",
                            "name": "Going Green Challenge",
                            "description": "This campaign is for Going Green Challenge ",
                            "date_created": "2011-05-05 16:09:54.997",
                            "start_date": "2011-05-05 16:09:54.997",
                            "end_date": "2012-05-04 16:09:54.997"
                        }
                    }
                },
                "member": {
                    "id": "DAE57893-36FD-4158-9F27-803775380D0B",
                    "email": "lsmith@example.com",
                    "screen_name": "Lillian Smith",
                    "first_name": "Lillian",
                    "last_name": "Smith",
                    "job_title": "Quality Inspector",
                    "address": "742 Evergreen Terrace, Springfield, IL",
                    "phone": "(123)456-7890",
                    "mobile_phone": "(987)654-3210",
                    "external_user_id": "123",
                    "skills": "Boxer, Mascot, Plow Driver, Food Critic",
                    "work_history": "Country Western Manager, Garbage Commissioner",
                    "photo_url": "https://example.brightideatest.com/api3/file/3557DDBA-0671-4D0D-8FA4-70A211A5B959?format=binary&thumb_size=100",
                    "date_created": "2011-05-05 16:09:52.720",
                    "date_modified": "2013-12-12 15:33:54.090",
                    "active": true,
                    "photo_file_id": "3557DDBA-0671-4D0D-8FA4-70A211A5B959",
                    "department": "Quality Department"
                }
            }
        ],
        "stats": {
            "total": "8",
            "page_count": 4,
            "current_page": 4
        }
    }
    




CREATE commentVote

Create a commentVote object.

Requester must have access to the Campaign in order to create a commentVote in it.

Parameters

Parameters Detail
comment_id
required
This is the ID of the comment where the vote applies
Sample value: "11111111-1111-1111-1111-111111111111"
type
required
This is the type of vote
Accepted Value: "promote", "demote"
format
optional
Specifies returned data format
Accepted value: "json", "xml"

Resource Information

Authentication: Required. See Authentication for details on authentication.

HTTP Methods: POST

Request URL Format: https://{api_domain}/api3/commentVote

Access Permission

Requester must have access to the Campaign in order to create a commentVote in it. See Authentication for details on authentication.

Requester can only create commentVote for himself. Only one commentVote is allowed per member per comment.

Errors

  • Invalid comment ID

  • Missing required parameter

  • Vote type must one of these values: "promote", "demote"

Example Request

  • Method: POST
  • Header: Authorization=Bearer 85f7b2462570acdde9a458ba6495b8763dcd040c
  • URL: https://example.brightidea.com/api3/commentVote
  • Form data:

    • comment_id=09599E37-BECE-4618-8667-8AF4F8A99B44
    • type=promote
    {
        "commentVote": {
            "comment_id": "09599E37-BECE-4618-8667-8AF4F8A99B44",
            "date_created": "2013-12-24 16:05:47.640",
            "type": "promote",
            "comment": {
                "id": "09599E37-BECE-4618-8667-8AF4F8A99B44",
                "date_created": "2011-12-09 15:43:24.810",
                "text": "new comment",
                "idea": {
                    "id": "94D1CA24-3CE7-4FA7-AF36-4CB06D259325",
                    "date_created": "2011-12-09 14:39:43.863",
                    "date_modified": "2011-12-09 14:39:43.863",
                    "title": "Friday Idea",
                    "description": "Today is Friday",
                    "visible": true,
                    "anonymous": false,
                    "idea_code": "D201",
                    "stage_id": null,
                    "step_id": null,
                    "campaign": {
                        "id": "CE640FD7-42AF-45A2-9137-D21D65B43AD2",
                        "name": "Going Green Challenge",
                        "description": "This campaign is for Going Green Challenge ",
                        "date_created": "2011-05-05 16:09:54.997",
                        "start_date": "2011-05-05 16:09:54.997",
                        "end_date": "2012-05-04 16:09:54.997"
                    }
                }
            },
            "member": {
                "id": "15B35D1E-52E1-4660-A38C-BF7BE5F50789",
                "email": "lsmith@example.com",
                "screen_name": "Lillian Smith",
                "first_name": "Lillian",
                "last_name": "Smith",
                "job_title": "Quality Inspector",
                "address": "742 Evergreen Terrace, Springfield, IL",
                "phone": "(123)456-7890",
                "mobile_phone": "(987)654-3210",
                "skills": "Truck driver, Plow Driver, Food Critic",
                "work_history": "Mayor, Country Western Manager, Garbage Commissioner",
                "date_created": "2011-07-19 15:23:52.740",
                "date_modified": "2013-09-25 11:06:47.900",
                "active": true,
                "department": "Quality Department"
            }
        },
        "total_count": 1,
        "promote_count": 2,
        "demote_count": 1
    }
    




DELETE commentVote

Delete a commentVote object.

Requester can delete his own submitted commentVote.

Parameters

Parameters Detail
comment_id
required
This is the ID of the comment where the vote applies
Sample value: "11111111-1111-1111-1111-111111111111"
format
optional
Specifies returned data format
Accepted value: "json", "xml"

Resource Information

  • Authentication: Required. See Authentication for details on authentication.
  • HTTP Methods: DELETE
  • Request URL Format: https://{api_domain}/api3/commentVote

Access Permission

Requester can delete his own submitted vote.

Errors

  • Invalid GUID received

Example Request

  • Method: DELETE
  • Header: Authorization=Bearer 85f7b2462570acdde9a458ba6495b8763dcd040c
  • URL: https://example.brightidea.com/api3/commentVote

    {
        "message": "success",
        "code": 200
    }
    




FAQ

Question: LIST commentVote only return 100 objects maximum per request. How do I retrieve more results.

Answer: LIST commentVote response is automatically paginated. You can specify which page of the result a request should return. For example, if you requested for 100 vote objects in the initial request, pass "page_size=100&page=2" to get the next 100. page_count is returned with every LIST request so your application can figure out when it hits the end.