: 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 the recent posts made by your colleagues.
See Authenticating requests
for information about how to authenticate the request.
Table 1. Atom API request details
Gets a feed that lists the messages, status messages, and some of the message comments posted to the boards of a person's colleagues. You must provide one of the following parameters to specify the person whose colleagues you want information about:
Use one or more of the input parameters to narrow the search. Separate multiple parameters with an ampersand (&).
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.
Table 2. Input parameters
Parent topic: Getting Profiles feeds
Retrieving status messages
Specifies whether to include comments associated with the status message. The options are:
Includes the first, second-to-last, and last comment associated with an entry. The comments are represented as top-level entries. For example:
<entry *a comment*>
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:
<entry *a comment*>
Includes none of the comments.
Internet email address of the person for which you want to retreive colleague messages.
Format the HTTP request using the proper URL encoding. For example, the encoded form of the @ symbol is %40 as in:
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.
Specifies the type of messages you want to return in the feed. The options are:
You can specify more than one option; separate multiple message types with a comma. By default, all message types are included.
Page number. Specifies the page to be returned. The default value is 1, which returns the first page.
Page size. Specifies the number of entries to return per page. The default value is 10. The maximum value you can specify is 250.
Includes in the resulting feed all entries published after a specified date.
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
. 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
Defines the order in which to display the entries in the returned feed. The option are:
Sorts the entries by the last modified date.
Sorts the entries by the date the item was published (usually related to atom:published element).
Use with the sortOrder parameter to specify which to show first: the most recent or oldest.
Specifies the order in which to sort the results. The options are:
Sorts the results in ascending order.
Sorts the results in descending order.
Unique ID that represents a specific person. The user ID is stored in the div element that has the x-lconn-userid class attribute.
Note: You must provide either this parameter or the email parameter.