Community articleGetting all status messages
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 status messages that have been posted by people in your organization.
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 status messages that have been posted by people in your organization.

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 percent sign (%) or asterisk (*). Use % to match any single character; encode it correctly using %25. Use * to match zero or more characters.
Input
Method URI Description
GET /profiles/atom/mv/theboard/entries/all.do Gets a feed that lists all of the status messages that have posted by people in your organization.
Name Type Optional Description
comments
enumerated Yes Specifies whether or not to include the comments associated with each update. The options are:
all: Includes the first, second-to-last, and last comment associated with an entry. The comments are represented as top-level entries. For example:
<feed>
<entry>
<entry *a comment*>
</feed>
inline: Includes the first, second-to-last, and last comment associated with an entry. The comments are represented as entries within a comments element. For example:
<feed>
<entry>
<comments>
<entry *a comment*>
</comments>
</entry>
</feed>
none: Includes none of the comments
Authorized values:
  • all
  • inline
  • none
email
string Yes Internet email address of the person whose status updates you wish to view.
Format the HTTP request using the proper URL encoding. For example, the encoded form of the @ symbol is %40 as in:
adam_eventide%40garden.com
Note: You must provide either this parameter or the userid parameter. Do not provide this parameter if IBM® Connections is configured to prevent email addresses from being displayed. It will return an error code. Use the key or userid parameters instead.
messageTypes
enumerated Yes
Specifies the type of updtaes you want to return in the feed. The options are:
status
simpleEntry
You can specify more than one option; separate multiple message types with a comma. By default, all message types are included.
Authorized values:
  • status
  • simpleEntry
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 updates 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:
  • moderated
  • 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
since
string Yes Includes in the resulting feed all entries published after a specified date.
The since and sinceEntryId parameters must be specified as a pair. The resulting feed is also dependent on the sort order parameter, descending order is the default. The sinceEntryId parameter is the entry identifier for each board entry.
For sortOrder=desc, the feed includes entries added before specified sinceEntryId and "since" date in descending order.
For sortOrder=asc, the feed include entries added after specified sinceEntryId and "since" date in ascending order.
Specify the date using a date-time value that conforms to http://www.ietf.org/rfc/rfc3339.txt" target="external">RFC3339. In addition, an uppercase T character must be used to separate date and time, and an uppercase Z character must be present in the absence of a numeric time zone offset. For example: 2012-01-04T20:32:31.171Z.
sinceEntryId
string Yes Includes in the resulting feed all entries published after a specified date.
The since and sinceEntryId parameters must be specified as a pair. The resulting feed is also dependent on the sort order parameter, descending order is the default. The sinceEntryId parameter is the entry identifier for each board entry.
For sortOrder=desc, the feed includes entries added before specified sinceEntryId and "since" date in descending order.
For sortOrder=asc, the feed include entries added after specified sinceEntryId and "since" date in ascending order.
Specify the date using a date-time value that conforms to http://www.ietf.org/rfc/rfc3339.txt" target="external">RFC3339. In addition, an uppercase T character must be used to separate date and time, and an uppercase Z character must be present in the absence of a numeric time zone offset. For example: 2012-01-04T20:32:31.171Z.
Output
Content Type: application/atom+xml
Code Description
200
OK. Indicates that the request was received successfully.