Retrieving the Activities service document

Retrieve the Activities service document

The first step perform if you plan to update resources made available through the Atom APIs is to retrieve the service document for the application. Alternatively, you can use the Overview feed, which is the feed that populates the My Activities view, to make updates.

Table 1. Atom API request details

Method	Resource	URI	Description
GET	Service document	/service/atom2/service	Accesses a user's service document to retrieve links to a user's Activities views which are listed as collections.

Example

To retrieve the service document for the Activities application, send the following request:

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

The HTTP response would look as follows:

< HTTP/1.1 200 OK
< Cache-Control: no-cache
< Content-Type: application/atomsvc+xml;charset=UTF-8
< Content-Language: en
< Set-Cookie: ...
< Set-Cookie: ...
< Set-Cookie: JSESSIONID=0000l9h_PZQRC_zsg9Hodp-iMe-:-1; Path=/
< Transfer-Encoding: chunked
< Date: Tue, 26 Feb 2008 20:13:37 GMT
< Server: WAS/6.1
< Expires: Thu, 01 Dec 1994 16:00:00 GMT

The service document for Activities is returned. For example:

<?xml version="1.0" encoding="utf-8" ?> 
<service 
 xmlns="http://www.w3.org/2007/app" 
 xmlns:atom="http://www.w3.org/2005/Atom">
  <atom:generator 
   uri="http://www.ibm.com/xmlns/prod/sn" 
   version="1.0.2">IBM Connections - Activities
  </atom:generator> 
  <workspace>
    <atom:title>Activity Dashboard for Amy jones11</atom:title> 
    <collection href="https://enterprise.example.com:9444/activities/service/atom2/
     activities">
      <atom:title>Overview</atom:title> 
      <accept>entry</accept> 
      <categories 
       href="https://enterprise.example.com:9444/activities/service/atom2/
       categories"/> 
      <categories 
       href="https://enterprise.example.com:9444/activities/service/atom2/tags"/> 
      <atom:id>https://enterprise.example.com:9444/activities/service/atom2/
       activities/overview</atom:id> 
    </collection>
    <collection 
     href="https://enterprise.example.com:9444/activities/service/atom2/completed">
      <atom:title>Completed</atom:title> 
      <accept /> 
      <atom:id>https://enterprise.example.com:9444/activities/service/atom2/
       completed</atom:id> 
    </collection>
    <collection 
     href="https://enterprise.example.com:9444/activities/service/atom2/tunedout">
      <atom:title>Tuned out</atom:title> 
      <accept /> 
      <atom:id>https://enterprise.example.com:9444/activities/service/atom2/
       tunedout</atom:id> 
    </collection>
    <collection 
     href="https://enterprise.example.com:9444/activities/service/atom2/trash">
      <atom:title>Trash</atom:title> 
      <accept /> 
      <atom:id>https://enterprise.example.com:9444/activities/service/atom2/
       trash</atom:id> 
    </collection>
    <collection 
     href="https://enterprise.example.com:9444/activities/service/atom2/public">
      <atom:title>Public</atom:title> 
      <accept /> 
      <atom:id>https://enterprise.example.com:9444/activities/service/atom2/
       public</atom:id> 
    </collection>
    <collection 
     href="https://enterprise.example.com:9444/activities/service/atom2/everything">
      <atom:title>Everything</atom:title> 
      <accept /> 
      <atom:id>https://enterprise.example.com:9444/activities/service/atom2/
       everything</atom:id> 
    </collection>
    <collection 
     href="https://enterprise.example.com:9444/activities/service/atom2/todos">
      <atom:title>To Do List</atom:title> 
      <accept /> 
      <atom:id>https://enterprise.example.com:9444/activities/service/atom2/
       todos</atom:id> 
    </collection>
  </workspace>
  <workspace>
    <atom:title>Activities for Amy jones11</atom:title> 
    <collection 
     href="https://enterprise.example.com:9444/activities/service/atom2/
     activity?activityUuid=342G7F000001B1A6C9CB0FB4FB4F460000D7">
      <atom:title>Testing Activities Member management with Janet</atom:title> 
      <accept>entry</accept> 
      <categories 
       href="https://enterprise.example.com:9444/activities/service/atom2/
       categories?activityUuid=342G7F000001B1A6C9CB0FB4FB4F460000D7" /> 
      <categories 
       href="https://enterprise.example.com:9444/activities/service/atom2/
       tags?activityUuid=342G7F000001B1A6C9CB0FB4FB4F460000D7" /> 
      <atom:link 
       rel="replies" 
       href="https://enterprise.example.com:9444/activities/service/atom2/
       threaded?activityUuid=342G7F000001B1A6C9CB0FB4FB4F460000D7" /> 
      <atom:id>urn:lsid:ibm.com:oa:342G7F000001B1A6C9CB0FB4FB4F460000D7</atom:id> 
    </collection>
    <collection 
     href="https://enterprise.example.com:9444/activities/service/atom2/
     activity?activityUuid=993G7F00000163CF90A98D71C92F700002F0">
     <atom:title>Activity Name:1105140702</atom:title> 
     <accept>entry</accept> 
       <categories 
        href="https://enterprise.example.com:9444/activities/service/atom2/
        categories?activityUuid=993G7F00000163CF90A98D71C92F700002F0" /> 
       <categories href="https://enterprise.example.com:9444/activities/service/
        atom2/tags?activityUuid=993G7F00000163CF90A98D71C92F700002F0" /> 
     <atom:link 
      rel="replies" 
      href="https://enterprise.example.com:9444/activities/service/atom2/
      threaded?activityUuid=993G7F00000163CF90A98D71C92F700002F0" /> 
     <atom:id>urn:lsid:ibm.com:oa:993G7F00000163CF90A98D71C92F700002F0</atom:id> 
    </collection>
  </workspace>
</service>

Parent topic

Activities API

});