Community articleIBM Connections Microblogging API
Added by IBM contributorIBM on June 26, 2014
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

No abstract provided.


In this documentation - and more widely in IBM Connections - the term "microblogging" refers to these 3 type of objects:
  • A "status update" - which is a short public message with no specific target user.
  • A short public message posted to another user.
  • A short message posted to a community.

The Microblogging API allows to perform the following operations:

  • Post and delete status updates, a short public messages to another user and short messages to a community.
  • Post and delete comments to status update and messages
  • Like and un-like status updates and messages

Note that there is no OpenSocial specifications entirely covering the use cases for microblogging. The Microblogging API provided is consequently specific to IBM Connections - but shared after the OpenSocial 'spirit':

  • The API provided by IBM Connections present data leveraging the existing OpenSocial-defined datamodel for ActivityStream
  • The URL patterns follow the OpenSocial conventions

Relation with the Activity Stream APIs

While, events about microblog objects are notably surfaced through the Activity Stream API, it is important to understand the Microblogging and Activity Stream APIs serves different purposes and are independent.

The Activity Stream API is used by the views named "Recent Updates" and "Status Updates" in Homepage, Profiles and Communities UI. The Activity Stream is therefore the primary way for end-users to discover microblog in the IBM Connections UI. However, the Activity Stream APIs returns events about any type of object in IBM Connections and 3rd party events - the term "microblog" does not refer to all events surfaced in the Activity Stream API.

APIs available

Retrieving microblog entries

Posting microblog entries

Dealing with microblog recommendations

Handling attachments