Getting the Subcommunities feed
Added by IBM contributorIBM | Edited by Claudia R Elbourn on June 11, 2015
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

Get a list of subcommunities associated with a community.
Tags: commapi

Discoverability

Available from the href attribute of the <link> element associated with the community of interest that has a rel="http://www.ibm.com/xmlns/prod/sn/subcommunities" attribute value in the My Communities collection.

Request parameters

Use one or more of the input parameters to narrow the search. Separate multiple parameters with an ampersand (&).

Input
Method URI Description
GET /communities/service/atom/community/subcommunities Available from the href attribute of the <link> element associated with the community of interest that has a rel="http://www.ibm.com/xmlns/prod/sn/subcommunities" attribute value in the My Communities collection.
Name Type Optional Description
asc
boolean Yes Specifies whether the results should be displayed in ascending order. Options are true or false.
page
number 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 10. The maximum value you can specify is 10000
since
number Yes Includes in the resulting feed all communities updated after a specified date. Specify the date using a date-time value that conforms to http://www.ietf.org/rfc/rfc3339.txt" target="external">RFC3339. Use an upper case "T" to separate the date and time, and an uppercase "Z" in the absence of a numeric time zone offset. For example: 2009-01-04T20:32:31.171Z.
sortBy
enumerated Yes Specifies the order in which to sort the results. Options are:
count
Sorts the entries by the number of members that belong to the item.
modified
Sorts the entries by the last modified date.
title
{{{Sorts the entries alphabetically by title. The title used is the text that is displayed in the <title> element of each entry in the feed.}}}
Note: This parameter replaces the sortField parameter. The sortField parameter and its associated options (count, lastmod, and name) are supported for backwards compatibility only; they will be deprecated in a future release.
Authorized values:
  • count
  • modified
  • title
sortOrder
enumerated Yes Specifies the order in which to sort the results. The options are:
asc
<a name="d7130e221"/>
Sorts the results in ascending order.
desc
<a name="d7130e226"/>
Sorts the results in descending order.
Authorized values:
  • asc
  • desc
communityUuid
string No The uuid of community that you want to query about. This is a mandatory parameter
Output
Content Type: application/atom+xml
Code Description
200
OK. Indicates that the request was received successfully.
Examples

Response returned by the server
<feed>

	<id>

	https://enterprise.example.com/communities/service/atom/community/subcommunities?

	communityUuid=055f503b-454b-4f30-8ba7-b21b6e2a77a7

	</id>

	<updated>2010-09-14T21:28:32.500Z</updated>

	<title type="text">Day Care - Subcommunities</title>

	<link

	href="https://enterprise.example.com/communities/service/html/allcommunities"

	rel="alternate"/>

	<generator uri="http://www.ibm.com/xmlns/prod/sn" version="3.0.1.0">

	IBM Connections - Communities

	</generator>

	<opensearch:totalResults>1</opensearch:totalResults>

	<opensearch:startIndex>1</opensearch:startIndex>

	<opensearch:itemsPerPage>10</opensearch:itemsPerPage>

	<link

	href="https://enterprise.example.com/communities/service/atom/community/subcommunities?

	communityUuid=055f503b-454b-4f30-8ba7-b21b6e2a77a7"

	rel="self"/>

	<link

	href="https://enterprise.example.com/communities/service/atom/service"

	rel="http://www.ibm.com/xmlns/prod/sn/service"

	type="application/atomsvc+xml"/>

	<link

	href="https://enterprise.example.com/communities/service/atom/community/subcommunities?

	communityUuid=055f503b-454b-4f30-8ba7-b21b6e2a77a7&outputType=categories"

	rel="http://www.ibm.com/xmlns/prod/sn/tag-cloud"

	type="application/atomcat+xml"/>

	<entry>

	<id>

	http://communities.ibm.com:2006/service/atom/community/instance?communityUuid=

	9dc395ef-bcc3-4cc8-88c5-18fa1aa91d4b

	</id>

	<title type="text">Massachusetts area</title>

	<summary type="text">

	Share information and resources about day care options in the Massachusetts area.

	</summary>

	<content type="html"/>

	<published>2010-09-14T21:23:55.981Z</published>

	<author>

	<name>Sally Mar</name>

	<email>smar@example.com</email>

	<snx:userid>50730340-0101-102e-88e1-f78755f7e0ed</snx:userid>

	<snx:userState>active</snx:userState>

	</author>

	<updated>2010-09-14T21:23:56.047Z</updated>

	<contributor>

	<name>Sally Mar</name>

	<email>smar@example.com</email>

	<snx:userid>50730340-0101-102e-88e1-f78755f7e0ed</snx:userid>

	<snx:userState>active</snx:userState>

	</contributor>

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

	<link

	href="https://enterprise.example.com/communities/service/atom/community/instance?

	communityUuid=9dc395ef-bcc3-4cc8-88c5-18fa1aa91d4b"

	rel="self"/>

	<link

	href="https://enterprise.example.com/communities/service/atom/community/instance?

	communityUuid=9dc395ef-bcc3-4cc8-88c5-18fa1aa91d4b"

	rel="edit"/>

	<link

	href="https://enterprise.example.com/communities/service/html/communityview?

	communityUuid=9dc395ef-bcc3-4cc8-88c5-18fa1aa91d4b"

	rel="alternate"

	type="text/html"/>

	<link

	href="https://enterprise.example.com/communities/service/html/image?

	communityUuid=9dc395ef-bcc3-4cc8-88c5-18fa1aa91d4b&lastMod=1284499436047"

	rel="http://www.ibm.com/xmlns/prod/sn/logo"/>

	<link

	href="https://enterprise.example.com/communities/service/atom/community/service?

	communityUuid=9dc395ef-bcc3-4cc8-88c5-18fa1aa91d4b"

	rel="http://www.ibm.com/xmlns/prod/sn/service"

	type="application/atomsvc+xml"/>

	<link

	href="https://enterprise.example.com/communities/service/atom/community/members?

	communityUuid=9dc395ef-bcc3-4cc8-88c5-18fa1aa91d4b"

	rel="http://www.ibm.com/xmlns/prod/sn/member-list"

	type="application/atom+xml"/>

	<link

	href="https://enterprise.example.com/communities/service/atom/community/bookmarks?

	communityUuid=9dc395ef-bcc3-4cc8-88c5-18fa1aa91d4b"

	rel="http://www.ibm.com/xmlns/prod/sn/bookmarks"

	type="application/atom+xml"/>

	<link

	href="https://enterprise.example.com/communities/service/atom/community/feeds?

	communityUuid=9dc395ef-bcc3-4cc8-88c5-18fa1aa91d4b"

	rel="http://www.ibm.com/xmlns/prod/sn/feeds"

	type="application/atom+xml"/>

	<link

	href="https://enterprise.example.com/communities/service/atom/community/

	remoteApplications?communityUuid=9dc395ef-bcc3-4cc8-88c5-18fa1aa91d4b"

	rel="http://www.ibm.com/xmlns/prod/sn/remote-applications"

	type="application/atom+xml"/>

	<link

	href="https://enterprise.example.com/communities/service/atom/community/forum/topics?

	communityUuid=9dc395ef-bcc3-4cc8-88c5-18fa1aa91d4b"

	rel="http://www.ibm.com/xmlns/prod/sn/forum-topics"

	type="application/atom+xml"/>

	<link

	href="https://enterprise.example.com/communities/service/atom/community/invites?

	communityUuid=9dc395ef-bcc3-4cc8-88c5-18fa1aa91d4b"

	rel="http://www.ibm.com/xmlns/prod/sn/invitations-list"

	type="application/atom+xml"/>

	<snx:membercount>2</snx:membercount>

	<snx:communityType>public</snx:communityType>

	<snx:handle>ma</snx:handle>

	<link

	href="https://enterprise.example.com/communities/service/atom/community/instance?

	communityUuid=055f503b-454b-4f30-8ba7-b21b6e2a77a7"

	rel="http://www.ibm.com/xmlns/prod/sn/parentcommunity"

	type="application/atom+xml"/>

	</entry>

	</feed>