Activity resource

Get activity list - Get activity list v1

OVERVIEW

Note: The latest specification for Collaborate 4.1.4 and above is here 

This API method can be used to obtain a collection of activity items. The activity is based on a specific filter.

By default the activity of the authenticated OAuth token are used to provide the activity, however if the OAuth token user has got administrative rights they are able to obtain activity on behalf of other users.

The type of activity returned can be altered by the filter parameters.

Each activity has an Actor, Verb and Object:

Actor: A person that performs the activity (user object) 

Verb : The activities verb, which indicates what action was performed

Object: The object of the activity

 

e.g. Mark posted a comment on the wiki page "Welcome to the show"

In the above activity description, "Mark" is the actor, "posted" is the verb and "wiki page" is the object.

<noofcomments> <nooflikes> <comments> <images> tags are only included in the returned xml when there are values available for those items.

The activity ID is only returned for microblog items and not for the any other activity.

Request

 GET         /api/1/activities{?filter parameters}

 Parameters
 

Parameter Name

Value

Description

site

String

If siteid is provided, the parameter for sitescope is ignored, sitescope parameter is only considered when no siteid is given. 

For System Admin (scope can be all or it can be the sites they are a member of)

/api/1/activities?sitescope=
{all / memberoff /favourite}

people

String

Default scope is All. At one time only, one option is sent. 

Author [supports only one author at this time] (As on the person’s personal profile page)

e.g Imran is the OAuth user, now Imran wants the activity for Keyur, then the call will be 
/api/1/activities?
people=author&authoremail=keyur@highq.com

Following
/api/1/activities?people=following

Followers
/api/1/activities?people=followers

MyOrganisation (People in my organisation)

MentionsMe

contenttype

String

The type of content to filter by. Default is All, however you can filter by all content types available in the activity stream like

/api/1/activities?contenttype=files

The possible values for content types are: Microblogs

Files

Wiki

Blog

Tasks

Events

Comments

offset

int

The no of last activity fetched. 

limit

int

No of items to return. Default is 20 (Max is 100, Activity to a maximum of 3 months can be provided)

 

Response

Collection of activities

<activities>

<activity>

               <activitydesc></activitydesc>

              <timepublished>UTC date</timepublished>

             <actors>

               <actor> ( this is the user in our system ) 

                         <username></username>

                         <email>Email address</email>

                         <avatar></avatar>

                         <userlink></userlink>  ( link to the users API profile link)

               </actor>

                </actors>

              <sitename></sitename>

             <noofcomments></noofcomments>

            <nooflikes></nooflikes>

            <contentitem>

                        <id></id>

                        <title></title>

                       <link>{URL to the content on HighQ Collaborate, this is not an API endpoint link}</link>

                       <apilink></apilink> {ALL api endpoints have not yet been developed, so we will only provide the API link if it is available , e.g file link or micro blog}

                       <type>{Content type}</type>

                        <imagetype>{content type extension}</imagetype>

                       <author>

                                    <username></username>

                                    <email>Email Address</email>

                                    <avatar></avatar>

                                    <userlink></userlink>  ( link to the users profile )

                      </author>

                     <datepublished></datepublished>

                     <parentcontent> {In case of file, what is the parent content to which the content item belongs too}

                                    <title></title>

                                     <link></link>

                                    <apilink></apilink> {ALL api endpoints have not yet been developed, so we will only provide the API link if it is available , e.g file link or micro blog}

                     </parentcontent>

<comments>

              <comment>

                                   <text></text>

                                    <author>

                                                  <username></username>

                                                 <email>Email Address</email>

                                                  <avatar></avatar>

                                                 <userlink></userlink>  ( link to the users profile )

                                    </author>

                                    <datepublished></datepublished>

                                     <nooflikes></nooflikes>

                                   <images>

                                                  <image>

                                                             <imagelink> </imagelink>

                                                </image>

                                  <images>

             </comment>

            </comments>

            <images>

                           <image>

                                        <imagelink> </imagelink>

                          </image>

           </images>

            <contentitem>

</activity>

<activities>

 In case of an error, an error response is returned with the following format:

Error response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

 <error>                         <link>https://ankitjava.local.com/ankit_3_3_0/api/1/error/5650</link>            

            <summary>Access denied</summary>

</error>

Comments


1 Comments


Are there plans to filter activity by a folder?

Last Updated: Jun 10,2023