Activity resource

API to display the Activity filters

OVERVIEW

This API method can be used to obtain the list of filters available for the activity API, please note that this API only provide the filters relevant to a specific activity list and does not return the content activity. 

Request URI

GET         /api/2/activities/activityfilter{?filter parameters}

 

Parameters
 

Parameter Name Value Description
site String

This is an optional parameter if the parameter is not supplied or an "ALL" value is provided then filters relevant to the activity for all sites is returned. 

Provide a list of comma separated site ID's if activity filters for specific sites are required. 

e.g site = 10,11,12
contenttype String

If a limited set of filters are required then provide a comma separated list of content types

e.g contenttype = files, blog, wiki

otherwise, do not use this parameter or provide a value of "ALL" for this parameter. 

 

Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<activityfilter>
    <sitefilter>
        <favourite>
            <displayname>Favourite sites</displayname>
            <value>favourite</value>
        </favourite>
        <memberoff>
            <displayname>Sites I am a member of</displayname>
            <value>memberoff</value>
        </memberoff>
        <sites>
            <site>
                <id>3</id>
                <sitename>LocalAppliance</sitename>
            </site>
        </sites>
    </sitefilter>
    <contenttypes>
        <contenttype>       
            <displayname>Files</displayname>
            <value>files</value>
        </contenttype>   
        <contenttype>       
            <displayname>Wiki</displayname>
            <value>wiki</value>
        </contenttype>   
    </contenttypes>
    <peoplefilter>
        <peoples>
            <people>
                <userid>102</userid>
                <name>
                    <title>Title</title>
                    <firstname>first</firstname>
                    <lastname>lastname</lastname>
                </name>
                <userlink>https://domain.com/instance/api/2/users/102</userlink>
                <httplink>https://https://domain.com/instance/viewUserProfile.action?metaData.encryptTargetUserID=6nmQLN8jN8c=&amp;metaData.updateUserProfileProcess=true</httplink>
                <httpavatar>https://https://domain.com/instance/downloadUserAvatar.action?user.userId=102&amp;user.avatarWidth=48&amp;user.lastModifiedTime=1489717844500</httpavatar>
                <avatar>https://https://domain.com/instance/api/2/users/102/avatar?size=48&amp;lastmodifieddate=1489717844500</avatar>
                <email>first.lastname@highq.com</email>
                <status>Active</status>
                <org>1</org>
                <location>
                    <city>London</city>
                    <country>United Kingdom</country>
                </location>
            </people>
        </peoples>
        <myorganisation>
            <displayname>All of HighQ</displayname>
            <value>myorganisation</value>
        </myorganisation>
        <following>
            <displayname>People I'm following</displayname>
            <value>following</value>
        </following>
        <followers>
            <displayname>People following me</displayname>
            <value>followers</value>
        </followers>
        <mentionsme>
            <displayname>Mentions me </displayname>
            <value>mentionsme</value>
        </mentionsme>
    </peoplefilter>
</activityfilter>

 

 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>domain.com/instance/api/1/error/5650</link>            

            <summary>Access denied</summary>

</error>

Comments


0 Comments

Last Updated: Nov 08,2024