ActivityStreamResources REST spec

ActivityStreamResources.txt

h1. activity_stream 
{panel} 

h2. *GET* +activity_stream._format_+ 

*Description* 

Gets activity stream of an identity. If no *identity_id* param is specified, the default identity will be the authenticated identity (who makes this request). 

*Url* 

{noformat}http://{domain_name}/{rest_context_name}/private/api/social/{version}/{portal_container_name}/activity_stream.format{noformat} 

For example: 

http://platform35.demo.exoplatform.org/rest/private/api/social/v1/portal/activity_stream.json 

http://platform35.demo.exoplatform.org/rest/private/api/social/v1/portal/activity_stream.json?identity_id=1a2b3c4d5e6f7g8h9i 


*Supported Format* 

json 

*Requires Authentication* 
true 

*Parameters* 

* *Optional* 
## *identity_id* Specifies the identity associated to gets his activity stream. 
## *count* Specifies the number of activities to retrieve. Must be less than or equal to *100*. The value you pass as *count* is a maximum number of activities to be returned. The actual number of activities you receive maybe less than *count*. If no specified, 100 will be the default value. 
## *types* Specifies the list of activity with activity types to be retrieved. The value could have some values like: "all", "default", or "exosc:core,exosc:connection,exoct:event,exoct:forum". If no types is specified, "default" will be used. (//TODO finalize if "," is ok) 
## *since_timestamp* Returns the activities having the created timestamps greater than the specified *since_timestamp*. 
## *max_timestamp* Returns the activities having the created timestamps less than the specified *max_timestamp*. 
## *since_id* Returns the activities having the created timestamps greater than the specified *since_id*'s created timestamp. 
## *max_id* Returns the activities having the created timestamps less than the specified *max_id*'s created timestamp. 


*Examples* 

{panel} 

h1. activity_stream/feed 

{panel} 

h2. *GET* +activity_stream/feed._format_+ 

*Description* Gets activity feed (all activities associated with the authenticated identity or the specified *identity_id*.
*Url* 
{noformat}http://{domain_name}/{rest_context_name}/private/api/social/{version}/{portal_container_name}/activity_stream/feed.format{noformat} 

For example: 

http://platform35.demo.exoplatform.org/rest/private/api/social/v1/portal/activity_stream/feed.json 

http://platform35.demo.exoplatform.org/rest/private/api/social/v1/portal/activity_stream/feed.json?count=20 

*Supported Format* 
json 

*Requires Authentication* 
true 

*Parameters* 

* *Optional*
## *identity_id* Specifies the identity associated to gets his activity feed.
## *count* Specifies the number of activities to retrieve. Must be less than or equal to *100*. The value you pass as *count* is a maximum number of activities to be returned. The actual number of activities you receive maybe less than *count*. If no specified, 100 will be the default value. 
## *types* Specifies the list of activity with activity types to be retrieved. The value could have some values like: "all", "default", or "exosc:core,exosc:connection,exoct:event,exoct:forum". If no types is specified, "default" will be used. (//TODO finalize if "," is ok) 
## *since_timestamp* Returns the activities having the created timestamps greater than the specified *since_timestamp*. 
## *max_timestamp* Returns the activities having the created timestamps less than the specified *max_timestamp*. 
## *since_id* Returns the activities having the created timestamps greater than the specified *since_id*'s created timestamp. 
## *max_id* Returns the activities having the created timestamps less than the specified *max_id*'s created timestamp. 

*Examples* 

{panel} 

h1. activity_stream/connections 


{panel} 

h2. *GET* +activity_stream/connections+ 

*Description* Gets connections' activity stream associated with the authenticated identity. 

*Url* 

{noformat}http://{domain_name}/{rest_context_name}/private/api/social/{version}/{portal_container_name}/activity_stream/connections.format{noformat} 

For example: 

http://platform35.demo.exoplatform.org/rest/private/api/social/v1/portal/activity_stream/connections.json 

http://platform35.demo.exoplatform.org/rest/private/api/social/v1/portal/activity_stream/connections.json?count=20&max_id=1a2b3c4d5e6f7g8h9i 

*Supported Format* 

json 

*Requires Authentication* 
true 

*Parameters* 

* *Optional* 
## *count* Specifies the number of activities to retrieve. Must be less than or equal to *100*. The value you pass as *count* is a maximum number of activities to be returned. The actual number of activities you receive maybe less than *count*. If no specified, 100 will be the default value. 
## *types* Specifies the list of activity with activity types to be retrieved. The value could have some values like: "all", "default", or "exosc:core,exosc:connection,exoct:event,exoct:forum". If no types is specified, "default" will be used. (//TODO finalize if "," is ok) 
## *since_timestamp* Returns the activities having the created timestamps greater than the specified *since_timestamp*. 
## *max_timestamp* Returns the activities having the created timestamps less than the specified *max_timestamp*. 
## *since_id* Returns the activities having the created timestamps greater than the specified *since_id*'s created timestamp. 
## *max_id* Returns the activities having the created timestamps less than the specified *max_id*'s created timestamp. 

*Examples* 

{panel} 

h1. activity_stream/spaces 

{panel} 

h2. *GET* +activitystream/spaces._format_+ 

*Description* Gets all spaces' activities which the authenticated identity can access. 

*Url* 

{noformat}http://{domain_name}/{rest_context_name}/private/api/social/{version}/{portal_container_name}/activity_stream/spaces.format{noformat} 

For example: 

http://platform35.demo.exoplatform.org/rest/private/api/social/v1/portal/activity_stream/spaces.json 

http://platform35.demo.exoplatform.org/rest/private/api/social/v1/portal/activity_stream/spaces/json?count=30 

*Supported Format* 

json 

*Requires Authentication* 

true 

*Parameters* 

* *Optional* 
## *count* Specifies the number of activities to retrieve. Must be less than or equal to *100*. The value you pass as *count* is a maximum number of activities to be returned. The actual number of activities you receive maybe less than *count*. If no specified, 100 will be the default value. 
## *types* Specifies the list of activity with activity types to be retrieved. The value could have some values like: "all", "default", or "exosc:core,exosc:connection,exoct:event,exoct:forum". If no types is specified, "default" will be used. (//TODO finalize if "," is ok) 
## *since_timestamp* Returns the activities having the created timestamps greater than the specified *since_timestamp*. 
## *max_timestamp* Returns the activities having the created timestamps less than the specified *max_timestamp*. 
## *since_id* Returns the activities having the created timestamps greater than the specified *since_id*'s created timestamp. 
## *max_id* Returns the activities having the created timestamps less than the specified *max_id*'s created timestamp. 

*Examples* 

{panel} 

h1. activity_stream/identities 

{panel} 

h2. *GET* +activity_stream/identities._format_+ 

*Description* Gets activity stream from a specified list of identity. This is a good end point for a good feature: list and activity stream list. For example: Create a favorite list of identities to keep track their activities. The *identity_ids* param is required. 

Note: not a MUST implementation for 1.2. 

*Url* 

{noformat}http://{domain_name}/{rest_context_name}/private/api/social/{version}/{portal_container_name}/activity_stream/identities.format{noformat} 

For example:

http://platform35.demo.exoplatform.org/rest/private/api/social/v1/portal/activity_stream/identities.json?identity_ids=1a2b3c,4e5f6g7h,83hhf93th 

*Supported Format* 

json 

*Requires Authentication* 

true 

*Parameters* 

* *Required* 
## *identity_ids* The string of identities separated by a comma character (","). For example: 1a2b,3c4e,5d6f (//TODO finalize if "," is ok) 

* *Optional* 
## *count* Specifies the number of activities to retrieve. Must be less than or equal to *100*. The value you pass as *count* is a maximum number of activities to be returned. The actual number of activities you receive maybe less than *count*. If no specified, 100 will be the default value. 
## *types* Specifies the list of activity with activity types to be retrieved. The value could have some values like: "all", "default", or "exosc:core,exosc:connection,exoct:event,exoct:forum". If no types is specified, "default" will be used. (//TODO finalize if "," is ok) 
## *since_timestamp* Returns the activities having the created timestamps greater than the specified *since_timestamp*. 
## *max_timestamp* Returns the activities having the created timestamps less than the specified *max_timestamp*. 
## *since_id* Returns the activities having the created timestamps greater than the specified *since_id*'s created timestamp. 
## *max_id* Returns the activities having the created timestamps less than the specified *max_id*'s created timestamp. 

*Examples* 

{panel}