Community articleActivities API
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

The Activities application of IBM® Connections enables a team to collect, organize, share, and reuse work related to a project goal. The Activities API allows application programs to create new activities, and to read and modify existing activities.



The Activities application of IBM® Connections enables a team to collect, organize, share, and reuse work related to a project goal. The Activities API allows application programs to create new activities, and to read and modify existing activities.

REST API Methods

Attention: *The URIs provided in the Sample resource column are provided as examples and are subject to change from release to release. To use URIs that will not change, derive the URI. See the topics linked to from this table for more details.

Table 1. REST API feeds
Action
Sample resource*
Description
GET
/service/atom2/service
GET
/service/atom2/activities
GET
/service/atom2/completed
GET
/service/atom2/everything
GET
/service/atom2/todos
GET
/service/atom2/tags
GET
/service/atom2/entrytemplates?activityUuid=<uuid>
Retrieves a feed of entry templates
GET
/service/atom2/trash
Retrieves a feed of the activities and entries in the trash


Table 2. Activity REST API methods
Action
Sample resource*
Description
POST
/service/atom2/activities
GET
/service/atom2/activitynode?activityNodeUuid=<uuid>
PUT
/service/atom2/activitynode?activityNodeUuid=<uuid>
DELETE
/service/atom2/activitynode?activityNodeUuid=<uuid>
PUT
/service/atom2/trashednode?activityNodeUuid=<uuid>


Table 3. Activity entry REST API methods
Action
Sample resource*
Description
POST
/service/atom2/activity?activityUuid=<uuid>
GET
/service/atom2/activitynode?activityNodeUuid=<uuid>
PUT
/service/atom2/activitynode?activityNodeUuid=<uuid>
DELETE
/service/atom2/activitynode?activityNodeUuid=<uuid>
PUT
/service/atom2/trashednode?activityNodeUuid=<uuid>


Table 4. Activity member REST API methods
Action
Sample resource*
Description
POST
service/atom2/acl?activityUuid=<uuid>
GET
/service/atom2/acl?activityUuid=<uuid>&memberid=<actMemberID>
PUT
/service/atom2/acl?activityUuid=<uuid>&memberid=<actMemberID>
DELETE
/service/atom2/acl?activityUuid=<uuid>&memberid=<actMemberID>


Atom Elements

Related tasks

  • Getting a person's user ID in Activities
  • Changing entry types

  • Navigating Activities resources
    Describes how to navigate from one Activities resource to another using the resources made available through the API.

    Retrieving the Activities service document
    The first step you must 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.

    Getting Activities feeds
    Use the Atom subscription API to retrieve resources from the activities hosted by the Activities application.

    Working with activities programmatically
    Using the Atom Publishing Protocol, also known as AtomPub, you can create and update activities that you own or to which you have edit access.

    Working with activity nodes
    Using the Atom Publishing Protocol, also known as AtomPub, you can create and update activity nodes, which are entries that you can add to an activity to add content such as bookmarks, chats, email messages, files, and to-do items. A single activity can contain up to 2000 nodes. You can create and update activity entries that you own or to which you have edit access.

    Working with activity members
    Using the Atom Publishing Protocol, also known as AtomPub, you can add members to the access control list of standard activities, and make updates to the list.

    Working with entry templates programmatically
    Using the Atom Publishing Protocol, also known as AtomPub, you can create, update, and delete entry templates. An entry template is a prototype of an activity entry. You can create a template, and then use it to create multiple custom entries. Entry templates are available within the activity in which they were created only; they cannot be shared across activities.

    Activities Atom node data types
    Lists the Atom node types that can appear in feeds produced by the Activities API, or in an Atom Entry document produced or sent to the API.

    Activities field element
    Lists the field element types that can appear in an Atom entry document produced by or sent to the API.

    Activities feeds
    Lists the Atom feeds produced by the Activities API.