Search the to-do list 

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

Table 1. Atom API request details

Resource Description
service/atom2/todos A feed of to-do items.

Use one or more of the input parameters to narrow the search. Separate multiple parameters with an ampersand (&).

Table 2. Input parameters

Parameter Description
assignedto 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.

assignedToUserid User ID of the person to whom the to-do item is assigned.
email 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 Filters the search to find entries that contain fields of a certain type. The options are:

  • date

  • file

  • link

  • person

  • text

includeunassigned 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.

nodetype 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

page Page number. Specifies the page to be returned. The default is 1.
priority Priority level of the activity. Options are:
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.

ps Page size. Specify the number of entries to return per page.
public Specifies whether to include public activities in the search. Options are:
no

only

yes

search Well-formed full text search query. Performs a text search on activity titles and descriptions.
since Returns all entries last modified since a specified date. Specify the date in the number of milliseconds since January 1, 1970, 00:00:00 GMT time.
sortfields Order in which to sort the results. Options are:
lastmod

    Sorts the results by last modified date.

name

    Sorts the results by entry name.

createdby

    Sorts the results by author name.

sortorder Defines the order in which to sort the results. Options are:
0

    Ascending. This value is the default value.

1

    Descending.

Use with the sortfield parameter. For example, if you want to display the results by most recently modified, specify:

sortfields=lastmod&sortorder=0

tag Returns activities with the specified tag. Search by one tag at a time.
templates 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.

userid Unique ID that represents a specific person.


Example

To search for all to do items in all activities, send the following HTTP request:

> GET /activities/service/atom2/todos HTTP/1.1
> Authorization: Basic ...
> Host: activities.enterprise.example.com:9444
> Accept: */*

The HTTP response would look as follows:

HTTP/1.1 200 OK
< Cache-Control: no-cache
< Content-Type: application/atom+xml;charset=UTF-8
< Server: IBM OpenActivities (v1.0)
< Last-Modified: Thu, 07 Feb 2008 21:11:03 GMT
< Content-Language: en
< Set-Cookie: LtpaToken2=<token>; Path=/; 
Domain=.enterprise.example.com
< Set-Cookie: LtpaToken=<token>; Path=/; 
Domain=.enterprise.example.com
< Set-Cookie: JSESSIONID=0000mpJZ4mJBl6g33s8exeVK7zs:-1; Path=/
< Transfer-Encoding: chunked
< Date: Thu, 07 Feb 2008 22:27:57 GMT
< Expires: Thu, 01 Dec 1994 16:00:00 GMT

The following content is 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>


Parent topic

Getting Activities feeds


   

 

});

+

Search Tips   |   Advanced Search