Community articleCommunities API
Added by IBM contributorIBM on June 20, 2014
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

The Communities application of IBM® Connections enables people who share a common interest interact with one another. The Communities API allows application programs to retrieve community information, subscribe to community updates, and create or modify communities.
Tags: commapi



The Communities application of IBM® Connections enables people who share a common interest interact with one another. The Communities API allows application programs to retrieve community information, subscribe to community updates, and create or modify communities.

Communities implements the following types of APIs:

Subscription
Communities implements the Atom Syndication Format (Atom 1.0) to serve up Atom feeds that you can use in your applications to search for and retrieve information from any of the communities created by the people in your organization. The format documented here is what feed readers use to discover updated content in a community.
Publishing
Communities provides a set of feeds and Service Documents that implement the Atom Publishing Protocol. You can use these publishing APIs in your applications to interact with the Communities application programmatically. When interacting with communities to which you are a member, you can add feeds, bookmarks, and forum topics. You can also update and delete content that you created. When interacting with communities to which you are an owner, you can retrieve even more detailed information about the community. You can also add, update, and delete all community content as well as add and delete community members.

Navigating Communities resources
Describes how to navigate from one Communities resource to another using the resources made available through the API.

Retrieving the Communities service document
The first step you must perform if you plan to update resources made available through the Atom APIs is to retrieve the service document for the application.

Getting Communities feeds
Use the Atom subscription API to retrieve resources from the communities hosted by the Communities application.

Working with community bookmarks programmatically
Using the Atom Publishing Protocol, also known as AtomPub, you can create or update bookmarks in communities.

Working with communities programmatically
Using the Atom Publishing Protocol, also known as AtomPub, you can create or update communities that you own.

Working with subcommunities
Using the Atom Publishing Protocol, also known as AtomPub, you can retrieve, create, update, or delete subcommunities within a community.

Working with feed links
Using the Atom Publishing Protocol, also known as AtomPub, you can create or update feed links in communities.

Working with community forum topics
Using the Atom Publishing Protocol, also known as AtomPub, you can create or update topics in communities forums.

Working with community forum replies
Using the Atom Publishing Protocol, also known as AtomPub, you can create or update replies to forum topics in communities.

Working with community invitations
Using the Atom Publishing Protocol, also known as AtomPub, you can retrieve, create or delete invitations to join a community.

Working with community members
Using the Atom Publishing Protocol, also known as AtomPub, you can add members to the Communities access control list, and make updates to the list.

Working with remote applications
Using the Atom Publishing Protocol, also known as AtomPub, you can retrieve a feed of the remote applications that are deployed in a given community.

Working with Community Events widget
Using the Atom Publishing Protocol, also known as AtomPub, you can retrieve, create, update, or delete events within a community.

Communities Atom entry types
Lists the Atom entry types that can appear in feeds produced by the Communities API, or in an Atom Entry document produced or sent to the API.

Communities feeds
Lists the Atom feeds produced by the Communities API.