Community articleGetting a feed of entries in the to-do list
Added by IBM contributorIBM on June 19, 2014
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

Search for a set of to-do items that match a specific criteria.



Search for a set of to-do items that match a specific criteria.

 

Discoverability


You can derive the URL from the user's service document. Find the value of the href attribute of element that contains a title element which has a value of To Do List. 


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 /activities/service/atom2/todos
Name Type Optional Description
assignedto
string Yes Internet email address. Specifies by email address the person to whom the to-do item is assigned.
Format the HTTP request using the proper URL encoding. For example, the encoded form of the @ symbol is %40 as in:
adam_eventide%40garden.com
Note: Do not use this parameter if IBM® Connections is configured to prevent email addresses from being displayed. It is ignored. Use the assignedToUserid parameter instead.
assignToUserid
string Yes User ID of the person to whom the to-do item is assigned.
email
string Yes Internet email address. Specifies that you want to search for activities that you have in common with the user you specify by email address.
Format the HTTP request using the proper URL encoding. For example, the encoded form of the @ symbol is %40 as in:
adam_eventide%40garden.com
Note: Do not use this parameter if IBM® Connections is configured to prevent email addresses from being displayed. It will return an error. Use the userid parameter instead.
fieldtype
enumerated Yes Filters the search to find entries that contain fields of a certain type. The options are:
date
file
link
person
text

Authorized values:
  • date
  • file
  • link
  • person
  • text
includeunassigned
enumerated Yes Use with the assignedto parameter to retrieve all of the to-do items to which a specific user has access. When you specify the assignedto parameter alone, it returns only those to-do items assigned to the person. If you want to get a list of all of the to-do items that a person has access to, not just those assigned to him or her, use this parameter. For example:
/service/atom2/todos?assignedto=<email>&includeunassigned=yes
The options are:
no
Does not include to-do items that are not assigned to the person.
only
Returns only those to-do items to which the person has access, except those that are assigned to him or her.
yes
Includes to-do items to which the person has access, not only those that are assigned to him or her.
Authorized values:
  • no
  • only
  • yes
nodetype
enumerated Yes Filters the search results by type. Options are:
activity
bookmark (for backwards compatibility)
chat
comment (for backwards compatibility)
community_activity
email
entry
entrytemplate: Returns all entry templates associated with the activity.
file (for backwards compatibility)
reply
section
todo

Authorized values:
  • activity
  • bookmark
  • chat
  • comment
  • community_activity
  • email
  • entry
  • entrytemplate
  • file
  • reply
  • section
  • todo
page
int Yes Page number. Specifies the page to be returned. The default value is 1, which returns the first page.
priority
enumerated Yes Priority level of the activity. Option is:
medium
Returns activities identified as having a medium priority.
mediumOrHigh
Returns activities identified as having a high or medium priority.
high
Returns activities identified as having a high priority.
Authorized values:
  • medium
  • mediumOrHigh
  • high
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 100.
public
enumerated Yes Specifies whether to include public activities in the search. Options are:
no
Does not include public activities in the search.
only
Searches only public activities.
yes
Includes public activities in the search.
Authorized values:
  • no
  • only
  • yes
search
string Yes Well-formed full text search query. Performs a text search on activity titles and descriptions.
sortBy
enumerated Yes Order in which to sort the results. Options are:
createdby
Sorts the entries alphabetically by the name of the user who created 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 sortfields parameter. The sortfields parameter and its associated options (createdby, lastmod, and name) are supported for backwards compatibility only; they will be deprecated in a future release.
Authorized values:
  • createdby
  • modified
  • title
sortOrder
enumerated Yes Specifies the order in which to sort the results. The options are:
asc
Sorts the results in ascending order.
desc
Sorts the results in descending order.
The default value is desc.
Use this parameter with the sortBy parameter. For example, if you want to display the results by most recently modified, specify:
sortBy=modified&sortOrder=asc
Note: This option replaces the sortorder parameter (all lowercase) parameter. The sortorder parameter and its associated options 0 (which represents ascending) and 1 (which represents descending) are supported for backwards compatibility only. They will be deprecated in a future release.
You cannot submit a mix of old and new parameters on a request. For example, if you specify sortorder=asc&sortBy=title, the default value for sortOrder (which is desc) is used instead of the value you specify.
Authorized values:
  • asc
  • desc
tag
string Yes Returns activities with the specified tag. Search by one tag at a time.
templates
enumerated Yes Specifies whether to include templates in the search. Options are:
no
Does not include templates in the search.
only
Searches only templates.
yes
Includes templates in the search.
Authorized values:
  • no
  • only
  • yes
userid
string Yes Unique ID that represents a specific person.
Output
Content Type: application/atom+xml
Code Description
200
OK. Indicates that the request was received successfully.
Examples
> GET /activities/service/atom2/todos HTTP/1.1

	> Authorization: Basic ...

	> Host: activities.enterprise.example.com:9444

	> Accept: */*


Response returned by the server
<?xml version="1.0" encoding="utf-8"?>

	<feed xmlns="http://www.w3.org/2005/Atom"

	xmlns:app="http://www.w3.org/2007/app"

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

	xmlns:os="http://a9.com/-/spec/opensearch/1.1/"

	xmlns:xhtml="http://www.w3.org/1999/xhtml">

	

	<generator

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

	version="1.0.2">IBM Connections - Activities</generator>

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

	favicon.ico</icon>

	<logo>https://activities.enterprise.example.com:9444/activities/images/

	activityLogo2x1.png</logo>

	<id>https://activities.enterprise.example.com:9444/activities/service/atom2/

	todos</id>

	<title type="text">To Do List for Amy jones11</title>

	<updated>2008-02-07T21:11:03Z</updated>

	<author>

	<name>Amy jones11</name>

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

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

	</author>

	<link

	rel="self"

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

	atom2/todos"

	/>

	<link

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

	type="application/atomsvc+xml"

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

	atom2/service"

	/>

	<link

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

	type="application/atomcat+xml"

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

	atom2/tags"

	/>

	<link

	rel="alternate"

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

	html/todos" />

	<os:totalResults>1</os:totalResults>

	<entry>

	<id>urn:lsid:ibm.com:oa:642G7F000001B1A6C9CB0FB4FB4F46000111</id>

	<title type="text">Set up an e-meeting to do a dry run</title>

	<updated>2008-02-07T21:11:03Z</updated>

	<published>2008-02-07T21:08:31Z</published>

	<author>

	<name>Amy jones11</name>

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

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

	<snx:ldapid>AA4G7F000001B1A6C9CB0FB4FB4F46000109</snx:ldapid>

	</author>

	<contributor>

	<name>Amy jones11</name>

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

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

	<snx:ldapid>AA4G7F000001B1A6C9CB0FB4FB4F46000109</snx:ldapid>

	</contributor>

	<category

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

	<snx:assignedto>amy_jones11@us.example.com</snx:assignedto>

	<snx:duedate>2008-02-08T05:00:00Z</snx:duedate>

	<snx:activity>488G7F000001B1A6C9CB0FB4FB4F4600010A</snx:activity>

	<link

	rel="edit"

	type="application/atom+xml"

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

	atom2/activitynode?activityNodeUuid=642G7F000001B1A6C9CB0FB4FB4F46000111"

	/>

	<link

	rel="self"

	type="application/atom+xml"

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

	atom2/activitynode?activityNodeUuid=642G7F000001B1A6C9CB0FB4FB4F46000111"

	/>

	<link

	rel="alternate"

	type="application/xhtml+xml"

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

	html/activityentry?uuid=642G7F000001B1A6C9CB0FB4FB4F46000111"

	/>

	<link

	rel="alternate"

	type="text/html"

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

	html/activityentry?uuid=642G7F000001B1A6C9CB0FB4FB4F46000111"/>

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

	images/icon_taskIncomplete.gif</snx:icon>

	<content type="html"></content>

	</entry>

	</feed>