Community articleGetting all of the comments associated with a message
Added by IBM contributorIBM on March 11, 2014
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

Get a feed that lists all of the comments posted to a message board in response to a status message or other message.

Important note: the Profiles Board APIs have been deprecated from the 4.0 release. These APIs are still functional for backward compatibility reasons - but no new feature is surfaced through these APIs. For any new development work, please refer to the OpenSocial Microblogging APIs.



Get a feed that lists all of the comments posted to a message board in response to a status message or other message.

Use one or more of the input parameters to narrow the search. Separate multiple parameters with an ampersand (&).
Note: All search parameters support the use of the wildcards % or *. Use % to match any single character; encode it properly using %25. Use * to match zero or more characters.

Input
Method URI Description
GET /profiles/atom/mv/theboard/comments.do Gets a feed that lists all of the comments posted in response to a given message. You must specify a value for the entryID parameter to indicate the message for which you want to get the comments.
Name Type Optional Description
entryId
string No ID of the entry. You can determine the entryID of an entry by getting a feed of all of the entries posted to a specific person's message board. See Getting a person's message board entries.
page
int Yes Page number. Specifies the page to be returned. The default value is 1, which returns the first page.
ps
int Yes Page size. Specifies the number of entries to return per page. The default value is 10. The maximum value you can specify is 250.
sortBy
enumerated Yes Defines the order in which to display the entries in the returned feed. The option are:
modified
Sorts the entries by the last modified date.
published
Sorts the entries by the date the item was published (usually related to atom:published element).
Use with the sortOrder parameter to specify whether to show the most recent or the oldest entries first.
Authorized values:
  • modified
  • published
sortOrder
enumerated Yes Specifies the order in which to sort the results. The options are:
asc
Sorts the results in ascending order.
desc
Sorts the results in descending order.
Authorized values:
  • asc
  • desc
Output
Content Type: application/atom+xml
Code Description
200
OK. Indicates that the request was received successfully.