Getting a feed of completed activities
Added by IBM contributorIBM | Edited by Claudia R Elbourn on July 7, 2015
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

Get a feed of completed activities 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 Completed.

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/completed
Name Type Optional Description
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.
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.
since
number Yes 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.
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
Output
Content Type: application/atom+xml
Code Description
200
OK. Indicates that the request was received successfully.
Examples
> GET /activities/service/atom2/completed 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/completed</id>

  <title type="text">Completed Activities for Amy jones11</title>

  <updated>2008-02-07T23:23:52Z</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/completed"

  />

  <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/completed" /> 

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

  <entry>

    <id>urn:lsid:ibm.com:oa:488G7F000001B1A6C9CB0FB4FB4F4600010A</id>

    <title type="text">Review the presentation</title>

    <updated>2008-02-07T23:23:52Z</updated>

    <published>2008-02-07T21:07:11Z</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="activity" 

     label="Activity"/>

    <category 

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

     term="1" 

     label="Normal"/>

    <category 

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

     term="completed" 

     label="Completed"/>

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

    <category term="presentation" />

    <link 

     rel="http://www.ibm.com/xmlns/prod/sn/member-list" 

     type="application/atom+xml" 

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

      atom2/acl?activityUuid=488G7F000001B1A6C9CB0FB4FB4F4600010A" 

    />

    <link 

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

     type="application/atom+xml" 

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

      atom2/activity/history?activityUuid=488G7F000001B1A6C9CB0FB4FB4F4600010A" 

    />  

    <app:collection 

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

      atom2/activity?activityUuid=488G7F000001B1A6C9CB0FB4FB4F4600010A">

      <title type="text">Review the presentation</title>

      <app:categories 

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

        atom2/activity/categories?activityUuid=

        488G7F000001B1A6C9CB0FB4FB4F4600010A"/>

    </app:collection> 

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

    <link 

     rel="edit" 

     type="application/atom+xml" 

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

      atom2/activitynode?activityNodeUuid=488G7F000001B1A6C9CB0FB4FB4F4600010A" 

    />

    <link 

     rel="self" 

     type="application/atom+xml" 

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

      atom2/activity?activityUuid=488G7F000001B1A6C9CB0FB4FB4F4600010A"

    />

    <link 

     rel="alternate" 

     type="application/xhtml+xml" 

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

      html/activity/recent?activityUuid=488G7F000001B1A6C9CB0FB4FB4F4600010A"

    />

    <link 

     rel="alternate" 

     type="text/html" 

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

      html/activity/recent?activityUuid=488G7F000001B1A6C9CB0FB4FB4F4600010A"

    />

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

     images/activityIcon16.gif</snx:icon>

    <content type="text"></content>

  </entry>

</feed>