Community articleGetting Related Communities feeds
Added by IBM contributorIBM | Edited by IBM contributorLDD Webmaster on July 1, 2014
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

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



Get a feed that includes the Related Community entries in a specific community.

 

Authentication


Request parameters


You can use one or more of the input parameters to limit the number of entries returned in the feed. Separate multiple parameters with an ampersand (&).

Output


An Atom feed document containing the Related Community atom entries.


 

Input
Method URI Description
GET /communities/recomm/atom/relatedCommunities Get a feed that includes the Related Community entries in a specific community.
Name Type Optional Description
communityUuid
string No The uuid of the community which you want to add this Related Community to.
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 16. The maximum value you can specify is 100
sortBy
enumerated Yes Default value is lastmod. Specifies what to sort the returned entries by. Options are:
name
Sorts the entries by the name.
lastmod
Sorts the entries by the last modified date.
.
Authorized values:
  • name
  • lastmod
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
Output
Content Type: application/atom+xml
Code Description
200
OK. Indicates that the request was received successfully.
Examples
An Atom feed document containing the Related Community atom entries.
  GET /communities/recomm/atom/relatedCommunities?communityUuid=bfcec17e-235c-4bd7-9fd5-2ba98779bd70 HTTP/1.1


Response returned by the server
 HTTP/1.1 403 Forbidden

	

	HTTP/1.1 400 Bad Request or 500 or others

	Content-Type: text/xml;charset=UTF-8

	

	<error xmlns="http://www.ibm.com/xmlns/prod/sn">

	<code>400</code>

	<message>Error message </message>

	<trace>Exception trace </trace>

	</error>

	

	HTTP/1.1 200 OK

	Content-Type: application/atom+xml

	

	<feed xmlns="http://www.w3.org/2005/Atom" xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/" xmlns:snx="http://www.ibm.com/xmlns/prod/sn">

	<generator uri="http://www.ibm.com/xmlns/prod/sn" version="4.0.0.0">IBM Connections - Related Communities</generator>

	<opensearch:totalResults xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/">1</opensearch:totalResults>

	<opensearch:startIndex xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/">1</opensearch:startIndex>

	<opensearch:itemsPerPage xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/">10</opensearch:itemsPerPage>

	<id>urn:lsid:ibm.com:recomm:relatedcommunitiesbfcec17e-235c-4bd7-9fd5-2ba98779bd70</id>

	<title type="text">Related Communities of A testing parent community</title>

	<updated>2012-08-16T07:43:52.709Z</updated>

	<link href="http://lc30linux3.swg.usma.ibm.com/communities/recomm/atom_form/relatedCommunities?communityUuid=bfcec17e-235c-4bd7-9fd5-2ba98779bd70" rel="self" type="application/atom+xml">

	<link href="http://lc30linux3.swg.usma.ibm.com/communities/service/html/communityview?communityUuid=bfcec17e-235c-4bd7-9fd5-2ba98779bd70#fullpageWidgetId=Wa5e22304209b_4a88_8a5e_e08d6127a8f1" rel="alternate" type="text/html">

	<snx:communityUuid xmlns:snx="http://www.ibm.com/xmlns/prod/sn">bfcec17e-235c-4bd7-9fd5-2ba98779bd70</snx:communityUuid>

	<link href="http://lc30linux3.swg.usma.ibm.com/communities/service/html/communityview?communityUuid=bfcec17e-235c-4bd7-9fd5-2ba98779bd70" rel="http://www.ibm.com/xmlns/prod/sn/container" type="application/atom+xml">

	<snx:permissions xmlns:snx="http://www.ibm.com/xmlns/prod/sn">view,add</snx:permissions>

	<entry xmlns:snx="http://www.ibm.com/xmlns/prod/sn">

	<id>urn:lsid:ibm.com:recomm:relatedcommunity:11bd8995-8d8f-4a73-a633-26974984a1e5</id>

	<snx:communityUuid xmlns:snx="http://www.ibm.com/xmlns/prod/sn">bfcec17e-235c-4bd7-9fd5-2ba98779bd70</snx:communityUuid>

	<snx:relatedCommunityUuid xmlns:snx="http://www.ibm.com/xmlns/prod/sn">dc1a846d-59c3-4c95-9d13-6724582ab170</snx:relatedCommunityUuid>

	<snx:permissions xmlns:snx="http://www.ibm.com/xmlns/prod/sn">edit,delete</snx:permissions>

	<title type="text">This is a related community</title>

	<published>2012-08-16T07:43:52.000Z</published>

	<author>

	<snx:userid xmlns:snx="http://www.ibm.com/xmlns/prod/sn">50730340-0101-102e-88f0-f78755f7e0ed</snx:userid>

	<email>ajones22@janet.iris.com</email>

	<name>Amy Jones22</name>

	<snx:userState xmlns:snx="http://www.ibm.com/xmlns/prod/sn">active</snx:userState>

	</author>

	<updated>2012-08-16T07:43:52.000Z</updated>

	<contributor>

	<snx:userid xmlns:snx="http://www.ibm.com/xmlns/prod/sn">50730340-0101-102e-88f0-f78755f7e0ed</snx:userid>

	<email>ajones22@janet.iris.com</email>

	<name>Amy Jones22</name>

	<snx:userState xmlns:snx="http://www.ibm.com/xmlns/prod/sn">active</snx:userState>

	</contributor>

	<content type="text">Add a related community.</content>

	<category scheme="http://www.ibm.com/xmlns/prod/sn/type" term="relatedCommunity"></category>

	<link href="http://lc30linux4.swg.usma.ibm.com/communities/service/html/communityview?communityUuid=dc1a846d-59c3-4c95-9d13-6724582ab170" rel="http://www.ibm.com/xmlns/prod/sn/related-community" type="text/html">

	<link href="http://lc30linux4.swg.usma.ibm.com/communities/service/html/communityview?communityUuid=dc1a846d-59c3-4c95-9d13-6724582ab170" rel="alternate" type="text/html">

	<link href="http://lc30linux3.swg.usma.ibm.com/communities/recomm/atom_form/relatedCommunity?entryId=11bd8995-8d8f-4a73-a633-26974984a1e5" rel="self" type="application/atom+xml">

	<link href="http://lc30linux3.swg.usma.ibm.com/communities/recomm/atom_form/relatedCommunity?entryId=11bd8995-8d8f-4a73-a633-26974984a1e5" rel="edit" type="application/atom+xml">

	</entry>

	</feed>