CompoundTimelineEntries REST API endpoint

GET

Returns an array of objects containing compound (own, contacts’ and groups’) timeline entries for a sv:userIdentity.

Requirements

• Requires the feature "social collaboration" and that social collaboration is enabled on the sv:site.

Permissions

• Requires that the caller is the targeted sv:userIdentity and is authorized to READ on the sv:site.

Parameters

Name	Type	Default	Values	Description	Since
skip	number	0	Any positive value	Skips leading number of entries.
limit	number	10	1 - 50	Limits the number of entries to return.
offsetEntryId	string			From which point to retrieve following entries.	4.5.1
messageFormat	String	HTML	HTML, PLAIN, JSON, JSON_TREE, MARKDOWN	The data format for the message in the returned result (JSON_TREE since 2024.02.1, MARKDOWN since 2024.11.1). Legacy note! MARKDOWN is not applicable for entries stored in the legacy format used prior to 2024.02.1! Using MARKDOWN for such entries will result in the message being returned in HTML format instead.	8
escapeMessage	boolean	false		HTML escape the message in the returned result (not applicable when messageFormat is PLAIN or MARKDOWN).	8

Example URL

400.95b3be916257bc215c2fd/compoundtimelineentries

Example input

{
   "skip": 2,
   "limit": 5,
   "messageFormat": "PLAIN"
}

Example response

[
   {
      "id": "420.95b3be916257bc215c3f6",
      "creationDate": 1521891132679,
      "type": "entry",
      "author": {
         "id": "400.95b3be916257bc215c3ea",
         "fullName": "Anders Sjöstrand",
         "disabled": false,
         "BuddyIconSize_SMALL": "/images/200.95b3be916257bc215c3f4/1521891117530/dog.jpeg",
         "BuddyIconSize_LARGE": "/images/200.95b3be916257bc215c3f5/1521891117549/dog.jpeg",
         "BuddyIconSize_X_LARGE": "/images/200.95b3be916257bc215c3f6/1521891117564/dog.jpeg"
      },
      "isEditable": true,
      "isRemovable": true,
      "isHideable": true,
      "isBookmarkableInGroup": false,
      "isBookmarkable": true,
      "isLikable": true,
      "isSharable": true,
      "isCommentable": true,
      "message": "Jag gillar WebApps",
      "isModified": false,
      "likesCount": 0,
      "commentsCount": 0,
      "userLikes": false,
      "entryOwner": {
         "id": "401.95b3be916257bc215c3c0",
         "displayName": "Sitevision-gruppen",
         "URL": "/704.95b3be916257bc215c3b7.html",
         "disabled": false
      }
   }
]

DELETE

Hides an entry.

Returns an object containing status.

Note: Operation is not reversible. Hiding an entry removes the entry from the sv:userIdentity's compound timeline.

Requirements

• The feature "social collaboration" and that social collaboration is enabled on the sv:site.
• The caller must have a sv:userIdentity.

Permissions

• Hiding an entry that belongs to a sv:userIdentity's compound timeline requires that the caller is either the owner of the compound timeline or is authorized to MANAGE_USER_IDENTITIES.

Example URL

400.5cd1245216436c70ff91/compoundtimelineentries/420.53d6620c1643bceb6e41

Example response

{
   "success": true
}