Community entry content
Added by IBM contributorIBM | Edited by Claudia R Elbourn on June 9, 2015
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

Lists the elements in a community Atom entry.
Tags: commapi

All elements are in the http://www.w3.org/2005/Atom namespace, except those that are prefixed as follows:

snx


In the http://www.ibm.com/xmlns/prod/sn namespace.

 

Table 1. Community entry elements

Element
How treated on input
Description
<id>
Ignored
Unique identifier of a community entry.
<snx:communityUuid>
Ignored
Unique identifier of the community.
<title>
Required
Entry title; a descriptive title of the community entry as defined in the Atom specification.
<category scheme="http://www.ibm.com/xmlns/prod/sn/type" term="community"/>
Required
Identifies the entry as a community Atom entry.
<category scheme="http://www.ibm.com/xmlns/prod/sn/type" term="deleted"/>
Optional
If this term exists in the entry, then the Community is in the trash. If you remove this when putting the entry to the trash feed, you remove the Community from the trash. Note that only a Community admin can do this operation.
<category term="tag_word"/>
Optional
Represents a tag assigned to a community.
<link rel="self" href="..." />
Ignored
Use the web address in the href attribute to return a complete representation of this community as an Atom entry document.
<link rel="edit" type="application/atom+xml" href="edit_url" />
Ignored
Use the web address in the href attribute to obtain an Atom entry document containing a complete representation of this community. If you are an owner of the community, the following operations are supported:
GET
Use the web address in the href attribute to obtain a full representation of the community as an Atom entry document.
PUT
Use the web address in the href attribute to update this community.
DELETE
Use the web address in the href attribute to delete the community including all bookmarks, forum topics, and more.
<link rel="alternate" type="text/html" href="..."/>
Ignored
Use the web address in the href attribute to obtain a HTML representation of this community entry that can be displayed in a web browser.
<link rel="http://www.ibm.com/xmlns/prod/sn/logo" href="..." />
Ignored
Use the web address in the href attribute to obtain an image that represents the community's logo. The following operations are supported:
GET
Use the web address in the href attribute to obtain the community logo image file. If a logo has not been set, a default image is returned.
PUT
Use the web address in the href attribute to upload a new community logo image and replace the current one.

The content for the GET and PUT operations are just the bytes from the image file. The href url could be used in an HTML element.

Attention: Specify the content type of the image file being sent with the request. For example: "Content-Type: image/jpeg"

<link rel="http://www.ibm.com/xmlns/prod/sn/member-list" type="application/atom+xml" href="..." />
Ignored
This link references the list of community members. The following operations are supported:
GET
Use the web address in the href attribute to obtain a feed of members. You can subscribe to this address in a feed reader to keep up to date on the list of community members. Using links in the feed you can update or delete members.
POST
Use the web address in the href attribute to add a member to the community.
<link rel="http://www.ibm.com/xmlns/prod/sn/bookmarks" type="application/atom+xml" href="..." />
Ignored
This link references the community's list of bookmarks. The following operations are supported:
GET
Use the web address in the href attribute to obtain a feed of bookmarks. You can subscribe to this address in a feed reader to keep up to date on the bookmarks shared by the community. Using links in the feed you can update or delete bookmarks.
POST
Use the web address in the href attribute to add a bookmark to the community.
<link rel="http://www.ibm.com/xmlns/prod/sn/feeds" type="application/atom+xml" href="..." />
Ignored
This link references the community's list of subscriptions to feeds. The following operations are supported:
GET
Use the web address in the href attribute to obtain a feed of shared community feed addresses. You can subscribe to this address in a feed reader to keep up to date on the list of feeds shared by the community. Using links in the feed you can update or delete individual shared feeds.
POST
Use the web address in the href attribute to add a feed to the list of feeds shared by the community.
<link rel="http://www.ibm.com/xmlns/prod/sn/forum-topics" type="application/atom+xml" href="..." />
Ignored
Use the web address in the href attribute of this link to work with the forum topics of the community. The following operations are supported:
GET
Use the web address in the href attribute to obtain a feed of forum topics. You can subscribe to this address in a feed reader to keep up to date on the topics being discussed in the community. Using links in the topics feed you can update the topics or work with the replies to the topics.
POST
Use the web address in the href attribute to add a forum topic.
<link rel="http://www.ibm.com/xmlns/prod/sn/remote-applications" type="application/atom+xml" href="..." />
Ignored
Use the web address in the href attribute of this link to work with community widgets, such as community activities, wikis, or a community blog. The following operations are supported:
GET
Use the web address in the href attribute to obtain a list of the widgets associated with a community.
<link rel="http://www.ibm.com/xmlns/prod/sn/invitations-list" type="application/atom+xml" href="..." />
Ignored
Use the web address in the href attribute of this link to work with invitations. If you are an owner of the community, the following operations are supported:
GET
Use the web address in the href attribute to obtain a full representation of the invitation as an Atom entry document.
POST
Use the web address in the href attribute to invite someone to this community.
DELETE
Use the web address in the href attribute to decline an invitation.
<link rel="http://www.ibm.com/xmlns/prod/sn/parentcommunity" type="application/atom+xml" href="..." />

Note: This element is only present if the entry represents a subcommunity.
optional
Use the web address in the href attribute of this link to access the parent community of this subcommunity.

On input: the communityUuid of the href URL is evaluated. If it is the same uuid of the Community the entry is being PUT to, the Community is made a top level Community. Otherwise, the communityUuid of the href URL becomes the parent of the Community the entry is being Put to. Note that the new parent cannot be a sub-community. If it is, an error will be returned.

 

 

<link rel="http://www.ibm.com/xmlns/prod/sn/subcommunities" type="application/atom+xml" href="..." />

Note: This element is only present if the entry represents a community, and not a subcommunity.
Ignored
Use the web address in the href attribute of this link to work with subcommunities. The following operations are supported:
GET
Use the web address in the href attribute to obtain a feed of the subcommunities for this community.
<snx:handle>
Ignored
 
<snx:membercount>
Ignored
Contains the number of members of this community.
<snx:communityType>
Required
Indicates whether the community is public or private. Options are:
private
Community does not allow public access.
public
Community allows public access, and anyone can join.
publicInviteOnly
Community allows public access, but users must request to join.
<content type="html">
Required
A description of the community; may be empty.
<summary type="text">
Ignored
A plain text summary of the description of this community; this description is provided in feeds in place of the full description.
<published>
Ignored
The date an entry was published as defined in the Atom specification.
<updated>
Ignored
The date an entry was updated as defined in the Atom specification.
<author>
Ignored
The author of this community as defined in the Atom specification.
<contributor>
Ignored
The person who contributed to the community.
<link href="..." rel="http://www.ibm.com/xmlns/prod/sn/activitystream" type="application/atom+xml">}}}

Note: This element is only present if the OpenSocial service is enabled.
Ignored
Provides a link to the Atom feed for the Recent Updates events for the community.
<link href="..." rel="http://www.ibm.com/xmlns/prod/sn/microblog " type="application/atom+xml">}}}

Note: This element is only present if the OpenSocial service is enabled and if the community has the Status Updates widget
Ignored
Provides a link to the Atom feed for the Status Updates events for the community.
<snx:preModeration>
Optional
Indicates whether content approval for the community is enabled.
Options are true and false. If not specified, enableOnCreation value is used.
<snx:postModeration>
Optional
Indicates whether content flagging for the community is enabled.
Options are true and false. If not specified, enableOnCreation value is used.
<snx:isExternal>
Optional
Indicates whether external users may be added to the community.

Options are true and false. If not specified, false will be used for on-premise deployments while true will be used for Connections Cloud servers.

Note that this value cannot be true if the community type is public or publicInviteOnly.

<snx:communityStartPage>
Optional
Indicates the widget instance id of the widget to use for the start page. If not specified, or set to an empty string, the community overview is used as the start page
Input