Activities API
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.Activities implements the following APIs:
Subscription
- Activities implements the Atom Syndication Format (Atom 1.0) to serve Atom feeds that you can use in your applications to search for and retrieve information from any of the activities created by the people in your organization. The format documented here is what feed readers use to discover updated content in an activity.
Publishing
- Activities implements the Atom Publishing Protocol to enable you to programmatically manipulate Activities content. Activities provides a service document and some category documents. The service document contains the currently authenticated user's collections and feeds. One of the category documents contains a set of fixed categories that can be assigned to activities and entries and the other category document is a dynamic category document that contains a list of the tags in a single activity. You can use the publishing APIs in your applications to perform actions, such as starting an activity. When interacting with activities to which you have owner access, you can retrieve more detailed information about an activity. You can also delete, restore, or update the activity and any of its entries. When interacting with activities to which you have Author access, you can update, delete, and restore any activity entries that you authored; you can also add new entries.
Note: The activity nodes that define bookmark, file, and comment entries changed between version 1.0.x and version 2.0. These entries are no longer represented by separate node types; they are all represented by a single node type called entry. They are differentiated from one another by their field type. This change reflects the fact that you can add multiple files and multiple bookmarks to a single entry. You can still retrieve entries that were created using these 1.0.x node types with the 2.0 APIs, but you cannot create or update such entries. If you created activities in a 1.0.x version of IBM Connections that have entries of these types and have not updated the entries either through the user interface or the APIs since migrating the server to 2.0, the entries will continue to work as they did in the 1.0.x version of IBM Connections. However, as soon as you modify any entries of these node types, you can no longer edit them using the old API. This section describes how the new APIs work. You can find information about how the APIs worked in version 1.0.x at the following external web site:
- Navigate Activities resources
Describes how to navigate from one Activities resource to another using the resources made available through the API.
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.
Getting Activities feeds
Use the Atom subscription API to retrieve resources from the activities hosted by the Activities application.
Work 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.
Work 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. You can create and update activity entries that you own or to which you have edit access.
Work 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.
Work 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.