Community articleRelated Communities 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

The Related Community of IBM® Connections is a Community Widget which saves other communities links in current community as entries. Its API allows application programs to create new entry, and to read and modify existing entries.


The Related Community of IBM® Connections is a Community Widget which saves other communities links in current community as entries. Its API allows application programs to create new entry, and to read and modify existing entries.

Related Communities implements the following APIs:

Subscription

Related Communities implements the Atom Syndication Format (Atom 1.0) to serve Atom feeds that you can use in your applications to search for and retrieve information from any of the containing widget. The format documented here is what feed readers use to discover updated content in a Related Communities widget.

Publishing

Related Communities implements the Atom Publishing Protocol to enable you to programmatically manipulate Related Community enties.

Retrieving the Related Communities service document
To update resources made available through the Atom APIs, you must first retrieve the service document for the application.

Getting Related Communities feeds
Use the Atom subscription API to retrieve resources from the Related Communities widget hosted by a community.

Creating a Related Community programmatically
To add a Related Community entry to a Related Communities widget, send an Atom entry document containing the entry to the Related Communities resource.

Retrieving a Related Community programmatically
To retrieve complete information about a Related Community Entry, use the edit link found in the entry in the feed.

Updating a Related Community programmatically
To update a Related Community entry, send an updated entry document in Atom format to the existing entry's edit web address.

Deleting a Related Community programmatically
To delete a Related Community entry, use the HTTP DELETE method.