NewsFeed

Use this resource to retrieve an activity stream of a user.

Method summary

HTTP Method	Path	Description
GET	/scr/api/NewsFeed	Retrieves an activity stream of a user.

GET /scr/api/NewsFeed

Description: Use this method to retrieve an activity stream of a user.

Resource information

Requirements	Description
Response format	JSON
Requires authentication	Yes
Supports OAuth 2 client credentials	Yes, using a User Service ID containing Account Activity Category
Rate limited	Not yet

Parameters

Name	Location	Description	Required	Type
X-On-Behalf-Of	Header	The user context. The value must be a username in the account. The user must have permission to perform the action in the account and in the specified parent space, if any.	Required if Service ID OAuth credentials are used. Not required when using User Service ID OAuth credential.	String

Response

Example input

Using User Service ID OAuth 2 client credentials:

curl -i -H "Authorization: Bearer access_token" 
"https://your_server_url/scr/api/NewsFeed"

Using Service ID OAuth 2 client credentials:

curl -i -H "Authorization: Bearer access_token" 
    -H "X-On-Behalf-Of:user_name@domain.com" "https://your_server_url/scr/api/NewsFeed"

Example output

{  
   "messages":[  
      {  
         "processId":"5f500e12a00ea",
         "name":"username",
         "description":"received <i>1 task<\/i> in <i>ProcessApp with multiple tasks A - New for test.<\/i> workflow <span class='date'>6:23 PM<\/span>",
         "group":"Today"
      },
      {  
         "processId":"5f500e12a00ea",
         "name":"username",
         "description":"launched <i>ProcessApp with multiple tasks A - New for test.<\/i> workflow <span class='date'>6:23 PM<\/span>",
         "group":"Today"
      },
      {  
         "processId":"5f500e12a000f",
         "name":"username",
         "description":"received <i>1 task<\/i> in <i>ProcessApp with 1 task A - New for test.<\/i> workflow <span class='date'>6:23 PM<\/span>",
         "group":"Today"
      },
      {  
         "processId":"5f500e12a000f",
         "name":"username",
         "description":"launched <i>ProcessApp with 1 task A - New for test.<\/i> workflow <span class='date'>6:23 PM<\/span>",
         "group":"Today"
      }
   ]
}

Response properties

messages

The array of messages in reverse chronological order.

name

The full name of the user who is addressed in the message. If the user makes this API call, then the word You appears instead.

description

The text of the message that includes <i> and <span> markup. The span has a class of date.

group

States when the event occurred and contains one of the following possible values:

Today
Yesterday
The actual date, if the event occurred from the day before yesterday to 7 days ago
Older, if the event occurred more than 7 days ago

processId

Optional parameter. If the message is associated with a process, this property value is the ID of the process.

comment

Optional parameter. If the message is associated with a comment, this property value is the text of the comment.

Response messages

HTTP code	Reason
200	The request was completed successfully.
401	The user isn't authorized to make the request.