Retrieving a remote applications list

Retrieve a remote applications list

To retrieve a list of remote applications associated with a community, use the remote applications link in the community entry Atom document.

You can use this method to retrieve entries that represent any activities, bookmark collections, forums, and wikis associated with the community.

See Authenticating requests for information about how to authenticate the request.

Table 1. Atom API request details

Method	Resource	URI	Output representation
GET	community entry document	Value of the href attribute of <link> element that has the rel="http://www.ibm.com/xmlns/prod/sn/remote-applications" attribute in the community entry document.	remote applications list

Input

None.

Output

A feed that contains an entry for each remote application associated with the community. You can perform the following tasks using web addresses provided in the entries in the returned feed:

Use the href in the publish link to retrieve an Atom publishing service document that you can use to create a community-associated activity, blog, bookmark collection, forum, file collection, feed collection, or wiki. The publish link provides the web address of the service document, which contains the Atom collections that you can post new items to or use to list existing items. You can identify the publish link because it contains the following rel= attribute value:
Use the href in the feed link to retrieve a list of community-associated items. You can identify the feed link because it contains the following rel= attribute value:
Perform a quick search of the remote application's community-associated items using the web address provided in the template attribute of the <opensearch:Url> element. Before using the address, replace {searchTerm} with the string that you want to search for.

Returned HTTP headers

HTTP/1.1 200 OK

error codes

Content-Type: application/atom+xml

Error codes

HTTP/1.1 401 Unauthorized
HTTP/1.1 404 Not Found

Sample output:

<feed>
  <id>
    urn:lsid:ibm.com:communities:remoteapplicationfeed-99e2049e-1301-4116-8956-7e93b0e0f379
  </id>
  <title type="text">AJ6 community - Remote Applications</title>
  <updated>2010-08-12T13:21:37.889Z</updated>
  <generator uri="http://www.ibm.com/xmlns/prod/sn" version="3.0.1.0">IBM Connections - Communities</generator>
  <link 
   href="https://enterprise.example.com/communities/service/atom/community/remoteApplications?communityUuid=
    99e2049e-1301-4116-8956-7e93b0e0f379" 
   rel="self"/>
  <link 
   href="https://enterprise.example.com/communities/service/atom/community/service?communityUuid=
    99e2049e-1301-4116-8956-7e93b0e0f379" 
   rel="http://www.ibm.com/xmlns/prod/sn/service" 
   type="application/atomsvc+xml"/>
  <opensearch:totalResults>8</opensearch:totalResults>
  <opensearch:startIndex>1</opensearch:startIndex>
  <opensearch:itemsPerPage>10</opensearch:itemsPerPage>
  <entry>
    <category term="Forum" scheme="http://www.ibm.com/xmlns/prod/sn/type"/>
    <id>
      urn:lsid:ibm.com:communities:remoteapplication-W0256bd5bf9ae_4aaf_a845_4dacf7cb1406
    </id>
    <title type="text">Forums</title>
    <content type="text">Forum</content>
    <published>2010-08-11T22:14:59.820Z</published>
    <updated>2010-08-12T13:20:33.016Z</updated>
    <author>
      <name>Andy Jackson</name>
      <email>ajackson@example.com</email>
      <snx:userid>50730340-0101-102e-88e1-f78755f7e0ed</snx:userid>
      <snx:userState>active</snx:userState>
    </author>
    <link 
     href="https://enterprise.example.com/forums/atom/service?communityUuid=99e2049e-1301-4116-8956-7e93b0e0f379" 
     rel="http://www.ibm.com/xmlns/prod/sn/remote-application/publish" 
     type="application/atomsvc+xml"/>
    <link 
     href="https://enterprise.example.com/forums/atom/topics?communityUuid=99e2049e-1301-4116-8956-7e93b0e0f379" 
     rel="http://www.ibm.com/xmlns/prod/sn/remote-application/feed" 
     type="application/atom+xml"/>
    <opensearch:OpenSearchDescription>
    <opensearch:Url 
     type="application/atom+xml" 
     template="https://enterprise.example.com/forums/atom/topics?communityUuid=
      99e2049e-1301-4116-8956-7e93b0e0f379&search={searchTerm}"/>
    </opensearch:OpenSearchDescription>
    <link 
     href="https://enterprise.example.com/communities/service/atom/community/remoteApplications?communityUuid=
      99e2049e-1301-4116-8956-7e93b0e0f379&remoteAppId=W0256bd5bf9ae_4aaf_a845_4dacf7cb1406" 
     rel="self"/>
  </entry>
  <entry>
    <category term="Bookmarks" scheme="http://www.ibm.com/xmlns/prod/sn/type"/>
    <id>
      urn:lsid:ibm.com:communities:remoteapplication-W67b3d7ec362b_4e0a_9985_95b0d1e21da4
    </id>
    <title type="text">Bookmarks</title>
    <content type="text">Bookmarks</content>
    <published>2010-08-11T22:14:59.820Z</published>
    <updated>2010-08-12T13:20:33.016Z</updated>
    <author>
      <name>Andy Jackson</name>
      <email>ajackson@example.com</email>
      <snx:userid>50730340-0101-102e-88e1-f78755f7e0ed</snx:userid>
      <snx:userState>active</snx:userState>
    </author>
    <link 
     href="https://enterprise.example.com/communities/service/atom/community/bookmarks/service?communityUuid=
      99e2049e-1301-4116-8956-7e93b0e0f379" 
     rel="http://www.ibm.com/xmlns/prod/sn/remote-application/publish" 
     type="application/atomsvc+xml"/>
    <link 
     href="https://enterprise.example.com/communities/service/atom/community/bookmarks?communityUuid=
      99e2049e-1301-4116-8956-7e93b0e0f379&ps=5" 
     rel="http://www.ibm.com/xmlns/prod/sn/remote-application/feed" 
     type="application/atom+xml"/>
    <opensearch:OpenSearchDescription>
    <opensearch:Url 
     type="application/atom+xml" 
     template="https://enterprise.example.com/communities/service/atom/community/bookmarks?communityUuid=
      99e2049e-1301-4116-8956-7e93b0e0f379&search={searchTerm}"/>
    </opensearch:OpenSearchDescription>
    <link 
     href="https://enterprise.example.com/communities/service/atom/community/remoteApplications?communityUuid=
      99e2049e-1301-4116-8956-7e93b0e0f379&remoteAppId=W67b3d7ec362b_4e0a_9985_95b0d1e21da4" 
     rel="self"/>
  </entry>
  <entry>
    <category term="Files" scheme="http://www.ibm.com/xmlns/prod/sn/type"/>
    <id>
      urn:lsid:ibm.com:communities:remoteapplication-W164eeea1cc11_4ed6_ab6b_b20197160be3
    </id>
    <title type="text">Files</title>
    <content type="text">Files</content>
    <published>2010-08-11T22:14:59.820Z</published>
    <updated>2010-08-12T13:20:33.016Z</updated>
    <author>
      <name>Andy Jackson</name>
      <email>ajackson@example.com</email>
      <snx:userid>50730340-0101-102e-88e1-f78755f7e0ed</snx:userid>
      <snx:userState>active</snx:userState>
    </author>
    <link 
     href="https://enterprise.example.com/files/basic/api/community/99e2049e-1301-4116-8956-7e93b0e0f379/
      introspection" 
     rel="http://www.ibm.com/xmlns/prod/sn/remote-application/publish" 
     type="application/atomsvc+xml"/>
    <link 
     href="https://enterprise.example.com/files/basic/api/communitylibrary/99e2049e-1301-4116-8956-7e93b0e0f379/feed" 
     rel="http://www.ibm.com/xmlns/prod/sn/remote-application/feed" 
     type="application/atom+xml"/>
    <opensearch:OpenSearchDescription>
    <opensearch:Url 
     type="application/atom+xml" 
     template="https://enterprise.example.com/files/basic/api/communitylibrary/99e2049e-1301-4116-8956-7e93b0e0f379/
      feed?search={searchTerm}"/>
    </opensearch:OpenSearchDescription>
    <link 
     href="https://enterprise.example.com/communities/service/atom/community/remoteApplications?communityUuid=
      99e2049e-1301-4116-8956-7e93b0e0f379&remoteAppId=W164eeea1cc11_4ed6_ab6b_b20197160be3" 
     rel="self"/>
  </entry>
  <entry>
    <category term="Activities" scheme="http://www.ibm.com/xmlns/prod/sn/type"/>
    <id>
      urn:lsid:ibm.com:communities:remoteapplication-Wd7dbeeba0705_48e7_a164_ef9882dda56b
    </id>
    <title type="text">Activities</title>
    <content type="text">Activities</content>
    <published>2010-08-11T22:14:59.820Z</published>
    <updated>2010-08-12T13:20:33.016Z</updated>
    <author>
      <name>Andy Jackson</name>
      <email>ajackson@example.com</email>
      <snx:userid>50730340-0101-102e-88e1-f78755f7e0ed</snx:userid>
      <snx:userState>active</snx:userState>
    </author>
    <link 
     href="https://enterprise.example.com/activities/service/atom2/service?commUuid=
      99e2049e-1301-4116-8956-7e93b0e0f379" 
     rel="http://www.ibm.com/xmlns/prod/sn/remote-application/publish" 
     type="application/atomsvc+xml"/>
    <link 
     href="https://enterprise.example.com/activities/service/atom2/activities?commUuid=
      99e2049e-1301-4116-8956-7e93b0e0f379&public=yes&authenticate=no" 
     rel="http://www.ibm.com/xmlns/prod/sn/remote-application/feed" 
     type="application/atom+xml"/>
    <opensearch:OpenSearchDescription>
    <opensearch:Url 
     type="application/atom+xml" 
     template="https://enterprise.example.com/activities/service/atom2/activities?commUuid=
      99e2049e-1301-4116-8956-7e93b0e0f379&public=yes&authenticate=no&search={searchTerm}"/>
    </opensearch:OpenSearchDescription>
    <link 
     href="https://enterprise.example.com/communities/service/atom/community/remoteApplications?communityUuid=
      99e2049e-1301-4116-8956-7e93b0e0f379&remoteAppId=Wd7dbeeba0705_48e7_a164_ef9882dda56b" 
     rel="self"/>
  </entry>
  <entry>
    <category term="Wiki" scheme="http://www.ibm.com/xmlns/prod/sn/type"/>
    <id>
      urn:lsid:ibm.com:communities:remoteapplication-Wfaf3453a14c4_4eb1_852c_9d1486cfdef2
    </id>
    <title type="text">Wiki</title>
    <content type="text">Wiki</content>
    <published>2010-08-11T22:14:59.820Z</published>
    <updated>2010-08-12T13:20:33.016Z</updated>
    <author>
      <name>Andy Jackson</name>
      <email>ajackson@example.com</email>
      <snx:userid>50730340-0101-102e-88e1-f78755f7e0ed</snx:userid>
      <snx:userState>active</snx:userState>
    </author>
    <link 
     href="https://enterprise.example.com/wikis/basic/api/community/99e2049e-1301-4116-8956-7e93b0e0f379/
      introspection" 
     rel="http://www.ibm.com/xmlns/prod/sn/remote-application/publish" 
     type="application/atomsvc+xml"/>
    <link 
     href="https://enterprise.example.com/wikis/basic/api/communitywiki/99e2049e-1301-4116-8956-7e93b0e0f379/feed" 
     rel="http://www.ibm.com/xmlns/prod/sn/remote-application/feed" 
     type="application/atom+xml"/>
    <opensearch:OpenSearchDescription>
    <opensearch:Url 
     type="application/atom+xml" 
     template="https://enterprise.example.com/wikis/basic/api/communitywiki/99e2049e-1301-4116-8956-7e93b0e0f379/
      feed?search={searchTerm}"/>
    </opensearch:OpenSearchDescription>
    <link 
     href="https://enterprise.example.com/communities/service/atom/community/remoteApplications?communityUuid=
      99e2049e-1301-4116-8956-7e93b0e0f379&remoteAppId=Wfaf3453a14c4_4eb1_852c_9d1486cfdef2" 
     rel="self"/>
  </entry>
  <entry>
    <category term="Feeds" scheme="http://www.ibm.com/xmlns/prod/sn/type"/>
    <id>
      urn:lsid:ibm.com:communities:remoteapplication-Wdef133d71e65_4ece_817b_f87ce563333d
    </id>
    <title type="text">Feeds</title>
    <content type="text">Feeds</content>
    <published>2010-08-11T22:14:59.820Z</published>
    <updated>2010-08-12T13:20:33.016Z</updated>
    <author>
      <name>Andy Jackson</name>
      <email>ajackson@example.com</email>
      <snx:userid>50730340-0101-102e-88e1-f78755f7e0ed</snx:userid>
      <snx:userState>active</snx:userState>
    </author>
    <link 
     href="https://enterprise.example.com/communities/service/atom/community/feeds/service?communityUuid=
      99e2049e-1301-4116-8956-7e93b0e0f379" 
     rel="http://www.ibm.com/xmlns/prod/sn/remote-application/publish" 
     type="application/atomsvc+xml"/>
    <link 
     href="https://enterprise.example.com/communities/service/atom/community/feeds?communityUuid=
      99e2049e-1301-4116-8956-7e93b0e0f379&ps=5" 
     rel="http://www.ibm.com/xmlns/prod/sn/remote-application/feed" 
     type="application/atom+xml"/>
    <opensearch:OpenSearchDescription>
    <opensearch:Url 
     type="application/atom+xml" 
     template="https://enterprise.example.com/communities/service/atom/community/feeds?communityUuid=
      99e2049e-1301-4116-8956-7e93b0e0f379&search={searchTerm}"/>
    </opensearch:OpenSearchDescription>
    <link 
     href="https://enterprise.example.com/communities/service/atom/community/remoteApplications?communityUuid=
      99e2049e-1301-4116-8956-7e93b0e0f379&remoteAppId=Wdef133d71e65_4ece_817b_f87ce563333d" 
     rel="self"/>
  </entry>
  <entry>
    <category term="Blog" scheme="http://www.ibm.com/xmlns/prod/sn/type"/>
    <id>
      urn:lsid:ibm.com:communities:remoteapplication-W97bdbbe94ea8_4fc1_83f4_67898268f94c
    </id>
    <title type="text">Blog</title>
    <content type="text">Blog</content>
    <published>2010-08-11T22:14:59.820Z</published>
    <updated>2010-08-12T13:20:33.016Z</updated>
    <author>
      <name>Andy Jackson</name>
      <email>ajackson@example.com</email>
      <snx:userid>50730340-0101-102e-88e1-f78755f7e0ed</snx:userid>
      <snx:userState>active</snx:userState>
    </author>
    <link 
     href="https://enterprise.example.com/blogs/api/blogs?commUuid=99e2049e-1301-4116-8956-7e93b0e0f379" 
     rel="http://www.ibm.com/xmlns/prod/sn/remote-application/publish" 
     type="application/atomsvc+xml"/>
    <link 
     href="https://enterprise.example.com/blogs/atom/blogs?commUuid=99e2049e-1301-4116-8956-7e93b0e0f379" 
     rel="http://www.ibm.com/xmlns/prod/sn/remote-application/feed" 
     type="application/atom+xml"/>
    <opensearch:OpenSearchDescription>
    <opensearch:Url 
     type="application/atom+xml" 
     template="https://enterprise.example.com/blogs/atom?search={searchTerm}&commUuid=
      99e2049e-1301-4116-8956-7e93b0e0f379&ps=5&page=0&sortby=0&order=desc&lang=en"/>
    </opensearch:OpenSearchDescription>
    <link 
     href="https://enterprise.example.com/communities/service/atom/community/remoteApplications?communityUuid=
      99e2049e-1301-4116-8956-7e93b0e0f379&remoteAppId=W97bdbbe94ea8_4fc1_83f4_67898268f94c" 
     rel="self"/>
  </entry>
</feed>

Parent topic

Work with remote applications

});