To-do item 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 to-do item as it is defined by Atom.

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.

thr

In the http://purl.org/syndication/thread/1.0 namespace.

 

Table 1. To do item entry elements

Element
How treated on input
Description
<category scheme="http://www.ibm.com/xmlns/prod/sn/type" term="todo" label="To Do" />
Required
Identifies a to-do item.
<content type="html">
Required
HTML formatted contents of the to-do item. May be empty.
<title type="text">
Required
Entry title; a descriptive title of the to-do item specified in text format. The type attribute is optional; type="text" is the default and only format allowed.
<category scheme="http://www.ibm.com/xmlns/prod/sn/flags" term="completed"/>
Optional
Identifies a completed to-do item. If this flag is not present, the to-do item is not completed. This flag is ignored on input unless you are updating an existing to-do item.
<snx:assignedto name="name" userid="id">
Optional
Name and user ID of the person to whom the to-do item is assigned.

To create a to-do item that is not assigned to anyone, do not include this element in the Atom document.
<snx:duedate>
Optional
Specifies the due date of the to-do item. Use the following syntax: 2008-04-23T04:00:00Z
<snx:icon>
Optional
Link to an icon that depicts whether the to-do item has been checked off or not.
<author>

<name>

<email>

<snx:userid>

<snx:ldapid>

<snx:userStatus>

</author>
Ignored
The author of this to-do item. Accepts the <name> element as specified in the Atom specification. Also accepts the <snx:ldapid> and <snx:userid> elements. If IBM® Connections is configured to prevent email addresses from being displayed, then the <email> element is not supported. Otherwise, it can be used. The <snx:userStatus> element identifies whether the person is an active or inactive user.
<contributor>

<name>

<email>

<snx:userid>

<snx:ldapid>

<snx:userStatus>

</contributor>
Ignored
A contributor to this to-do item. Accepts the <name> element as specified in the Atom specification. Also accepts the <snx:ldapid> and <snx:userid> elements. If IBM Connections is configured to prevent email addresses from being displayed, then the <email> element is not supported. Otherwise, it can be used. The <snx:userStatus> element identifies whether the person is an active or inactive user.
<id>
Ignored
Unique identifier of the to-do item.
<link rel="edit" type="application/atom+xml" href="edit_url"/>
Ignored
Use this web address to obtain the latest full content (not just summary) of this to-do item and to update or delete it.
<link rel="self" type="application/atom+xml" href="..."/>
Ignored
As defined in the Atom specification.
<link rel="alternate" type="text/html" href="..."/>
Ignored
Use this web address to obtain a HTML representation of this to-do item suitable for display in a browser.
<link rel="alternate" type="application/xhtml+xml" href="..."/>
Ignored
As defined in the Atom specification.
<link type="application/xhtml+xml" href="..."/>
Ignored
Use this web address to obtain a HTML representation of this to-do item suitable for display in a browser.
<published>
Ignored
The date this to-do item was published, as defined in the Atom specification.
<snx:activity>
Ignored
Unique identifier of the activity in which this to-do item resides. The identifier is assigned to the activity by the server.
<thr:in-reply-to>
Optional; Specify this element if you want to add the to-do entry to a section.
Identifies the section to which the to-do entry belongs. For example:

<thr:in-reply-to

			ref="section-id"

			type="application/atom+xml"

			href="section's_edit_link_url"

			source="snx:activity-id"/>
<updated>
Ignored
The date this to-do item was updated, as defined in the Atom specification.
<snx:position>
Optional
Position of the to-do item in the containing activity entry's array of fields. Use numbers separated by large increments to allow for repositioning. For example, use 1000, 2000, 3000, and so on. Choose a number that positions the entry relative to other entries in the activity. If a number is used more than once, the server renumbers the entries, while maintaining the relative positions of all entries. If you do not assign a position value to the entry, the server assigns one.

 


Example


<entry>

<id>urn:lsid:ibm.com:oa:CB6G0A0A0A0A6A64A3530068E6E73C0002FF</id>

<title type="text">this is a longer one</title>

<updated>2008-04-22T17:22:43Z</updated>

<published>2008-04-22T17:22:43Z</published>

<author>

<name>Michelle Jenkins</name>

<email>michelle_jenkins@us.example.com</email>

<snx:userid>937965j0-4f0c-1028-5a06-db07163b51b2</snx:userid>

<snx:ldapid>96CG046E0E4B47BEF6967B3131AD5900026D</snx:ldapid>

</author>

<contributor>

<name>Michelle Jenkins</name>

<email>michelle_jenkins@us.example.com</email>

<snx:userid>937965j0-4f0c-1028-5a06-db07163b51b2</snx:userid>

<snx:ldapid>96CG046E0E4B47BEF6967B3131AD5900026D</snx:ldapid>

</contributor>

<category

scheme="http://www.ibm.com/xmlns/prod/sn/type" term="todo" label="To Do" />

<snx:duedate>2008-04-23T04:00:00Z</snx:duedate>

<snx:activity>3F8G0A0A0A0AAAF115C2B208A75140000002</snx:activity>

<link

rel="edit"

type="application/atom+xml"

href="https://sales.enterprise.example.com/activities/service/atom2/

activitynode?activityNodeUuid=CB6G0A0A0A0A6A64A3530068E6E73C0002FF" />

<link

rel="self"

type="application/atom+xml"

href="https://sales.enterprise.example.com/activities/service/atom2/

activitynode?activityNodeUuid=CB6G0A0A0A0A6A64A3530068E6E73C0002FF" />

<link

rel="alternate"

type="application/xhtml+xml"

href="https://sales.enterprise.example.com:443/activities/service/html2/

activityentry?uuid=CB6G0A0A0A0A6A64A3530068E6E73C0002FF" />

<link

rel="alternate"

type="text/html"

href="https://sales.enterprise.example.com:443/activities/service/html2/

activityentry?uuid=CB6G0A0A0A0A6A64A3530068E6E73C0002FF" />

<snx:position>16000</snx:position>

<snx:icon>https://sales.enterprise.example.com/activities/images/

icon_taskIncomplete.gif</snx:icon>

<content type="html">Will add more info here.<br>&nbsp;</content>

</entry>