Community articleBlogs definition content
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

Represents a blog and the associated settings that define how the blog operates.



Represents a blog and the associated settings that define how the blog operates.

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. Blog definition entry elements

Element
How treated on input
Description
<id>
Ignored
Unique identifier of a blog entry.
<title>
Required
Entry title; a descriptive title of the blog as defined in the Atom specification. This title is displayed at the top of the blog page and in the title field of the blog newsfeed. Maximum length is 255 characters. For community blogs and community ideation blogs, the title specified is the title of the community to which the blog was added.
<summary>
Optional
A short text description of the blog; may be empty. This description can display at the top of the blog depending on the blog theme. Maximum length is 255 characters.
<category term="tag_word"/>
Optional
Repeat for each tag. Use this element to tag the blog definition; these tags are kept separate from the tags assigned to the postings to this blog.
<link rel="edit" type="application/atom+xml" href="edit_url"/>
Ignored
If you are an owner of the blog, use the web address in the href attribute to update or delete the blog. If you are an author of the blog, the following operations are supported on the address:
GET
Obtains a full representation of this blog as an Atom entry document.
PUT
Updates this blog. First use the GET request to retrieve the current Atom document for the blog, make your updates, and then send the updated document as input to this request. If you do not first retrieve the current document, but instead send only your changes, you will lose the rest of the document content because all data is replaced by a PUT request.
DELETE
Deletes this blog, including all postings and comments.
<link rel="alternate" type="text/html" href="xxxxxx"/>
Ignored
Use this web address to obtain a HTML representation of this blog for display in a web browser.
<app:edited>
Ignored
The date that this blog was last modified, as defined in the Atom publishing protocol specification.
<author>
Optional
An owner of this blog. IBM® Connections automatically adds the user that created the blog as an author with owner permissions. This element may repeat for additional owners. Accepts the <name> element as specified in the Atom specification. You must also provide either an <email> or <snx:userid> element. If IBM Connections is configured to prevent email addresses from being displayed, then the <email> element is not supported. The <snx:userStatus> element identifies whether the person is an active or inactive user.
<contributor>
Optional
An additional author that may contribute to the blog with author permissions who is allowed to post entries, but is not an owner of the blog. See Table 2 for possible values of this element. This element may repeat for additional contributors.
<published>
Ignored
The date this blog was published, as defined in the Atom specification.
<updated>
Ignored
The date this blog was updated, as defined in the Atom specification.
<snx:handle>
Required
A one-word keyword for the blog to be used in the web address of the blog.

Note: This value must be unique across all of the blogs hosted by the Blogs server.
<snx:timezone>
Optional
The time zone for this blog. See Table 3 for a list of possible time zones.
<category term="" scheme="http://www.ibm.com/xmlns/prod/sn/type"/>
Optional
Defines the type of blog being defines. The options for term are:
  • blog
  • communityblog
  • ideationblog
If no type is defined, blog is assumed.
<snx:comments
enabled="yes|no"
days="<number>"/>
Optional
Specifies whether commenting is on or off.
<snx:emailcomments enabled="disabled|yes|no"/>
Optional
Indicates whether email notifications are sent when a comment is added. If email notifications are enabled for the entire blog, yes or no specifies whether or not emails are sent. The disabled option indicates that email notifications are disabled through a blog-wide setting.
<snx:commentmoderated enabled="yes|no"/>
Optional
Specifies whether comments are moderated or not.
<snx:AllowCoedit enabled="yes|no"/>
Optional
Indicates whether more than one person can edit the entry.
<snx:rank scheme="http://www.ibm.com/xmlns/prod/sn/recommendations">
Ignored
Number of users likes. For ideation blog, it is total number of votes.
<snx:rank scheme="http://www.ibm.com/xmlns/prod/sn/comment">
Ignored
Number of users comment.
<snx:rank scheme="http://www.ibm.com/xmlns/prod/sn/hit">
Ignored
Number of users hit.

Table 2. The <contributor> element

Element
How treated on input
Description
<email>
Optional
Must contain the email address of the person contributing to the blog. If IBM Connections is configured to prevent email addresses from being displayed, then this element is not supported. Use the <snx:userid> element instead. Otherwise, it can be used.
<snx:userid>
Required
The user ID of the contributor.
<snx:limited>
Optional
If present, and if this element contains "yes", then the contributor is only allowed to author draft entries.
<snx:userStatus>
Optional
Identifies whether the person is an active or inactive user.

Table 3. Community blog-specific elements

Element
How treated on input
Description
<category term="" scheme="http://www.ibm.com/xmlns/prod/sn/flags" label=""/>
The options for term and their corresponding labels are:
moderated
Moderated
private
Private
public
Public
<link href="" rel="http://www.ibm.com/xmlns/prod/sn/container" type="application/atom+xml"/>
Specifies the URL from which the owning community can be accessed.
<snx:containertype>
<snx:containerid>
<snx:communityUuid>
Identifies the blog as a community blog and identifies the community to which it belongs by the community’s unique ID..
<snx:maprole membership="">
Options for membership are:
  • member

Table 4. Community ideation blog-specific elements

Element
How treated on input
Description
<snx:voteLimit enabled="true|false" limit="" scheme="http://www.ibm.com/xmlns/prod/sn">
Optional
The vote limit settings.Default is no limit.
<snx:rank scheme="http://www.ibm.com/xmlns/prod/sn/votes-available">
Ignored
The available votes user has if vote limit is set.Default is -1.
<category term="" scheme="http://www.ibm.com/xmlns/prod/sn/flags" label=""/>
Optional
The options for term and their corresponding labels are:
closed
New ideas are closed.
frozen
New ideas and comments are closed.
open
Users can contribute new ideas or comment on or vote for existing ideas in this Ideation Blog.

Table 5. Time zones

Time zone
Description
Africa/Cairo
Africa/Cairo - Eastern European Time
Africa/Casablanca
Africa/Casablanca - Western European Time
Africa/Johannesburg
Africa/Johannesburg - South Africa Standard Time
Africa/Lagos
Africa/Lagos - Western African Time
Africa/Nairobi
Africa/Nairobi - Eastern African Time
America/Anchorage
America/Anchorage - Alaska Standard Time
America/Bogota
America/Bogota - Colombia Time
America/Buenos_Aires
America/Buenos_Aires - Argentine Time
America/Caracas
America/Caracas - Venezuela Time
America/Chicago
America/Chicago - Central Standard Time
America/Chihuahua
America/Chihuahua - Mountain Standard Time
America/Denver
America/Denver - Mountain Standard Time
America/Godthab
America/Godthab - Western Greenland Time
America/Halifax
America/Halifax - Atlantic Standard Time
America/Indianapolis
America/Indianapolis - Eastern Standard Time
America/Los_Angeles
America/Los_Angeles - Pacific Standard Time
America/Managua
America/Managua - Central Standard Time
America/Mexico_City
America/Mexico_City - Central Standard Time
America/New_York
America/New_York - Eastern Standard Time
America/Noronha
America/Noronha - Fernando de Noronha Time
America/Phoenix
America/Phoenix - Mountain Standard Time
America/Regina
America/Regina - Central Standard Time
America/Santiago
America/Santiago - Chile Time
America/Sao_Paulo
America/Sao_Paulo - Brasilia Time
America/St_Johns
America/St_Johns - Newfoundland Standard Time
Asia/Baghdad
Asia/Baghdad - Arabia Standard Time
Asia/Bangkok
Asia/Bangkok - Indochina Time
Asia/Calcutta
Asia/Calcutta - India Standard Time
Asia/Colombo
Asia/Colombo - Sri Lanka Time
Asia/Dhaka
Asia/Dhaka - Bangladesh Time
Asia/Irkutsk
Asia/Irkutsk - Irkutsk Time
Asia/Jerusalem
Asia/Jerusalem - Israel Standard Time
Asia/Kabul
Asia/Kabul - Afghanistan Time
Asia/Karachi
Asia/Karachi - Pakistan Time
Asia/Katmandu
Asia/Katmandu - Nepal Time
Asia/Krasnoyarsk
Asia/Krasnoyarsk - Krasnoyarsk Time
Asia/Magadan
Asia/Magadan - Magadan Time
Asia/Muscat
Asia/Muscat - Gulf Standard Time
Asia/Novosibirsk
Asia/Novosibirsk - Novosibirsk Time
Asia/Rangoon
Asia/Rangoon - Myanmar Time
Asia/Riyadh
Asia/Riyadh - Arabia Standard Time
Asia/Seoul
Asia/Seoul - Korea Standard Time
Asia/Shanghai
Asia/Shanghai - China Standard Time
Asia/Singapore
Asia/Singapore - Singapore Time
Asia/Taipei
Asia/Taipei - China Standard Time
Asia/Tbilisi
Asia/Tbilisi - Georgia Time
Asia/Tehran
Asia/Tehran - Iran Standard Time
Asia/Tokyo
Asia/Tokyo - Japan Standard Time
Asia/Vladivostok
Asia/Vladivostok - Vladivostok Time
Asia/Yakutsk
Asia/Yakutsk - Yakutsk Time
Asia/Yekaterinburg
Asia/Yekaterinburg - Yekaterinburg Time
Atlantic/Azores
Atlantic/Azores - Azores Time
Atlantic/Cape_Verde
Atlantic/Cape_Verde - Cape Verde Time
Australia/Adelaide
Australia/Adelaide - Central Standard Time (South Australia)
Australia/Brisbane
Australia/Brisbane - Eastern Standard Time (Queensland)
Australia/Darwin
Australia/Darwin - Central Standard Time (Northern Territory)
Australia/Hobart
Australia/Hobart - Eastern Standard Time (Tasmania)
Australia/Perth
Australia/Perth - Western Standard Time (Australia)
Australia/Sydney
Australia/Sydney - Eastern Standard Time (New South Wales)
Etc/GMT+12
Etc/GMT+12
Europe/Belgrade
Europe/Belgrade - Central European Time
Europe/Berlin
Europe/Berlin - Central European Time
Europe/Bucharest
Europe/Bucharest - Eastern European Time
Europe/Helsinki
Europe/Helsinki - Eastern European Time
Europe/Istanbul
Europe/Istanbul - Eastern European Time
Europe/London
Europe/London - Greenwich Mean Time
Europe/Moscow
Europe/Moscow - Moscow Standard Time
Europe/Paris
Europe/Paris - Central European Time
Europe/Sarajevo
Europe/Sarajevo - Central European Time
Pacific/Apia
Pacific/Apia - West Samoa Time
Pacific/Auckland
Pacific/Auckland - New Zealand Standard Time
Pacific/Fiji
Pacific/Fiji - Fiji Time
Pacific/Guam
Pacific/Guam - Chamorro Standard Time
Pacific/Honolulu
Pacific/Honolulu - Hawaii Standard Time
Pacific/Tongatapu
Pacific/Tongatapu - Tonga Time