GET updateComment {#get}

Get data of one comment object for a update.

Parameters

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

Resource Information

Authentication: See Access Permission for GET update

HTTP Methods: GET

Request URL Format: https://{api_domain}/api3/updateComment/{id}

Access Permission {#GetPermission}

Access to update data varies base on system setting. See Authentication for detail 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/updateComment/0A3835CD-766F-4720-9A54-BB7F7E5EE178

~~~ { "updateComment": { "id": "0A3835CD-766F-4720-9A54-BB7F7E5EE178", "comment": "John's comment", "datecreated": "2013-04-19 16:21:11.493", "updateid": "22B35AB4-C6AA-4586-ABCF-8C87A5A4AA75", "member": { "id": "866144B1-E302-42EF-AF80-75DE988885AE", "email": "jdoe@brightidea.com", "screenname": "John Doe", "firstname": "John", "lastname": "Doe", "jobtitle": "Sales", "address": "123 fake street", "phone": "123 456-789", "mobilephone": "987 654-3210", "externaluserid": "04567", "skills": "Selling Software", "workhistory": "Worked at sales.com", "photourl": "https://example.brightideatest.com/api3/file/02F11D0E-BA74-4A7D-B1BE-4F7F651B2507?format=binary&thumbsize=100", "datecreated": "2013-03-07 19:09:54.563", "datemodified": "2013-04-18 13:14:21.067", "active": true, "photofileid": "02F11D0E-BA74-4A7D-B1BE-4F7F651B2507" } } } ~~~

LIST updateComment {#list}

Get data on a list of comment objects for an update. 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 ----------------------------------- | ----------------------------------- id
optional |Filter return by updateComment ID.
Sample value: "11111111-1111-1111-1111-111111111111" update_id
optional |Filter return by update ID. Update is parent to updateComment
Sample value: "11111111-1111-1111-1111-111111111111" date_created
optional |Filter return by updateComment created date. Response contains all ideas created within the 24 hours of the specified date
Sample value: "12/06/2009" member_id
optional |Filter return by ID of updateComment creator
Sample value: "11111111-1111-1111-1111-111111111111" campaign_id
optional |Filter return by ID of a campaign
Sample value: "11111111-1111-1111-1111-111111111111" 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: {pagecount}
Sample value: 5 order
optional |A SQL style string that specifies the order the records should return in.
Sample value: "datecreated ASC".
Accepted attributes:"date_created" format
optional |Specifies returned data format
Accepted value: "json", "xml"

Resource Information

Authentication: See Access Permission for LIST updateComment

HTTP Methods: GET

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

Access Permission {#listPermission}

Access to update data varies base on system setting. See Authentication for detail 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/updateComment?update_id=E1906058-51AB-4A65-915B-DF39820EC5A7

~~~ { "updateCommentlist": [ { "id": "3A2B9082-FD11-4E71-8C74-101857100F9D", "comment": "Comment 2 for update A", "datecreated": "2013-04-19 18:43:29.873", "updateid": "E1906058-51AB-4A65-915B-DF39820EC5A7", "member": { "id": "8FA49B96-3693-4282-8919-014618D7B3B8", "screenname": "Lillian Smith", "firstname": "Lillian", "lastname": "Smith", "jobtitle": "", "address": "", "phone": "", "mobilephone": "", "externaluserid": "", "skills": "", "workhistory": "", "photourl": "", "datecreated": "2013-03-07 17:10:13.627", "datemodified": "2013-04-16 15:42:16.430", "active": true } }, { "id": "721F37D3-69FB-4757-B998-1BE06310F4B7", "comment": "Comment 1 for update A", "datecreated": "2013-04-19 18:43:08.483", "updateid": "E1906058-51AB-4A65-915B-DF39820EC5A7", "member": { "id": "866144B1-E302-42EF-AF80-75DE988885AE", "screenname": "John Doe", "firstname": "John", "lastname": "Doe", "jobtitle": "Sales", "address": "123 fake street", "phone": "123 456-789", "mobilephone": "987 654-3210", "externaluserid": "04567", "skills": "Selling Software", "workhistory": "Worked at sales.com", "photourl": "https://example.brightideatest.com/api3/file/02F11D0E-BA74-4A7D-B1BE-4F7F651B2507?format=binary&thumbsize=100", "datecreated": "2013-03-07 19:09:54.563", "datemodified": "2013-04-18 13:14:21.067", "active": true, "photofileid": "02F11D0E-BA74-4A7D-B1BE-4F7F651B2507" } } ], "stats": { "total": "2", "pagecount": 1, "currentpage": 1 } } ~~~

CREATE updateComment {#create}

Create a comment object for an update.

Requester must have access to the environment in order to create.

Parameters

Parameters | Detail ----------------------------------------| ----------------------------------- comment
required |This is the text of the comment. Minimum 1 character, long text field
Sample value: "This is a comment to an update" update_id
required |This is the ID of update where the comment should be created for
Sample value: "11111111-1111-1111-1111-111111111111" format
optional |Specifies returned data format
Accepted value: "json", "xml"

Resource Information

Authentication: Required. See Authentication for detail on authentication.

HTTP Methods: POST

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

Access Permission

Requester must have access to the environment in order to create an update in it. See Authentication for detail on authentication.

Errors

Missing required parameter

Example Request

Method: POST
Header: Authorization=Bearer 85f7b2462570acdde9a458ba6495b8763dcd040c
URL: https://example.brightidea.com/api3/updateComment
Form data:
- comment=Comment%201%20from%20API
- update_id=E1906058-51AB-4A65-915B-DF39820EC5A7
~~~ { "updateComment": { "id": "4D7C68A6-8408-4340-8EE1-EF6404F5F1CB", "comment": "Comment 1 from API", "datecreated": "2013-04-19 18:52:28.947", "updateid": "E1906058-51AB-4A65-915B-DF39820EC5A7", "member": { "id": "866144B1-E302-42EF-AF80-75DE988885AE", "screenname": "John Doe", "firstname": "John", "lastname": "Doe", "jobtitle": "Sales", "address": "123 fake street", "phone": "123 456-789", "mobilephone": "987 654-3210", "externaluserid": "04567", "skills": "Selling Software", "workhistory": "Worked at sales.com", "photourl": "https://example.brightideatest.com/api3/file/02F11D0E-BA74-4A7D-B1BE-4F7F651B2507?format=binary&thumbsize=100", "datecreated": "2013-03-07 19:09:54.563", "datemodified": "2013-04-18 13:14:21.067", "active": true, "photofileid": "02F11D0E-BA74-4A7D-B1BE-4F7F651B2507" } } } ~~~

DELETE updateComment {#delete}

Delete a comment object of an update. Requester must be an Admin.

Parameters

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

Resource Information

Authentication: Required. See Authentication for detail on authentication.
HTTP Methods: DELETE
Request URL Format: https://{api_domain}/api3/updateComment/{id}

Access Permission

Requester must be an Admin. See Authentication for detail on authentication.

Errors

Invalid GUID received
Admin permission required.

Example Request

Method: DELETE
Header: Authorization=Bearer 85f7b2462570acdde9a458ba6495b8763dcd040c
URL: https://example.brightidea.com/api3/updateComment/4D7C68A6-8408-4340-8EE1-EF6404F5F1CB

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

FAQ {#faq}

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

Answer: LIST updateComment response is automatically paginated. You can specify which page of the result a request should return. For example, if you requested for 100 idea 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.