BookmarkedTimelineEntries REST API endpoint

Disclaimer: This endpoint documentation is generated from the latest Sitevision version. It might differ from the actual Sitevision environment where your website resides.

Use the RestApi utility of the Public API for server-side access of this endpoint.

BookmarkedTimelineEntries

Get bookmarked timeline entries.

Applicable to: sv:userIdentity, sv:collaborationGroup.

GET

Returns a collection of bookmarked entries

Requirements

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

Permissions

Retrieving bookmarked entries from a sv:userIdentity requires that the sv:userIdentity is available and the caller is authorized to READ the sv:site.
Retrieving bookmarked entries from a sv:collaborationGroup requires that the caller is allowed to view the group and is authorized to READ the sv:collaborationGroupPage.

Retrieving a collection

Returns an array of objects containing bookmarked timeline entries from a sv:userIdentity or a sv:collaborationGroup.

Parameters

Name	Type	Default	Values	Description	Since
skip	`number`	0	Any positive value	Skips leading number of bookmarked entries.
limit	`number`	10	1 - 50	Limits the number of bookmarked entries to return.
messageFormat	`String`	HTML	HTML, PLAIN, JSON, JSON_TREE, MARKDOWN	The data format for the message in the returned result (JSON since 8, 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.
escapeMessage	`boolean`	false		HTML escape the message in the returned result (not applicable when messageFormat is PLAIN or MARKDOWN).	8

Example URL

400.4246245fa692dd1672f33/bookmarkedtimelineentries

Example input

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

Example response

[
   {
      "bookmarkId": "428.314bac03169baa8557566",
      "id": "420.264bac03169baa8557511",
      "creationDate": 1553615571265,
      "type": "entry",
      "author": {
         "id": "400.264bac03169baa855754",
         "fullName": "Leia Organa",
         "disabled": false,
         "BuddyIconSize_SMALL": "/images/200.95b3be916257bc215c3f4/19830930/princess.jpeg",
         "BuddyIconSize_LARGE": "/images/200.95b3be916257bc215c3f4/198309301/princess.jpeg",
         "BuddyIconSize_X_LARGE": "/images/200.95b3be916257bc215c3f5/198309302/princess.jpeg"
      },
      "isEditable": true,
      "isRemovable": true,
      "isBookmarkableInGroup": false,
      "isBookmarkable": true,
      "isLikable": true,
      "isSharable": true,
      "isCommentable": true,
      "message": "Help me Sitevision. You’re my only hope",
      "isModified": false,
      "likesCount": 405,
      "commentsCount": 0,
      "userLikes": true
   },
   {
      "bookmarkId": "428.554bac03169baa8557518",
      "id": "420.4a8c3b2116a2b3486291c",
      "creationDate": 1555509769309,
      "type": "entry",
      "author": {
         "id": "400.264bac03169baa855754",
         "fullName": "Darth vader",
         "disabled": false,
         "BuddyIconSize_SMALL": "/images/200.95b3be916257bc215c3f4/19840930/sithlord.jpeg",
         "BuddyIconSize_LARGE": "/images/200.95b3be916257bc215c3f4/198409301/sithlord.jpeg",
         "BuddyIconSize_X_LARGE": "/images/200.95b3be916257bc215c3f5/198409302/sithlord.jpeg"
      },
      "isEditable": true,
      "isRemovable": true,
      "isBookmarkableInGroup": false,
      "isBookmarkable": true,
      "isLikable": true,
      "isSharable": true,
      "isCommentable": true,
      "message": "I find your lack of Sitevision disturbing",
      "isModified": false,
      "likesCount": 1,
      "commentsCount": 0,
      "userLikes": true
   }
]

POST

Bookmark a timeline entry.

Requirements

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

Permissions

Bookmarking an entry for sv:userIdentity requires that the sv:userIdentity is available, the caller is available, the caller is authorized to READ the sv:site and the caller is either the sv:userIdentity or is authorized to MANAGE_USER_IDENTITIES.
Bookmarking an entry for a sv:collaborationGroup requires that the the group is active, the caller is allowed to view the group, the caller is authorized to READ the sv:collaborationGroupPage and is authorized to either USE_COLLABORATION_GROUP or MANAGE_COLLABORATION_GROUP.
To bookmark an entry in a sv:collaborationGroup, the entry must belong to the group.

Parameters

Name	Type	Default	Values	Description	Since
timelineEntryId	`string`			The id of the entry that will be bookmarked.
messageFormat	`String`	HTML	HTML, PLAIN, JSON, JSON_TREE, MARKDOWN	The data format for the message in the returned result (JSON since 8, 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.
escapeMessage	`boolean`	false		HTML escape the message in the returned result (not applicable when messageFormat is PLAIN or MARKDOWN).	8

Example URL

400.4246245fa692dd1672f33/bookmarkedtimelineentries

Example input

{
   "timelineEntryId": "420.264bac03169baa8557511"
}

Example response

{
      "bookmarkId": "428.314bac03169baa8557566",
      "id": "420.264bac03169baa8557511",
      "creationDate": 1553615571265,
      "type": "entry",
      "author": {
         "id": "400.264bac03169baa855754",
         "fullName": "Leia Organa",
         "disabled": false,
         "BuddyIconSize_SMALL": "/images/200.95b3be916257bc215c3f4/19830930/princess.jpeg",
         "BuddyIconSize_LARGE": "/images/200.95b3be916257bc215c3f4/198309301/princess.jpeg",
         "BuddyIconSize_X_LARGE": "/images/200.95b3be916257bc215c3f5/198309302/princess.jpeg"
      },
      "isEditable": true,
      "isRemovable": true,
      "isBookmarkableInGroup": false,
      "isBookmarkable": true,
      "isLikable": true,
      "isSharable": true,
      "isCommentable": true,
      "message": "<p>Help me Sitevision. You’re my only hope</p>",
      "isModified": false,
      "likesCount": 405,
      "commentsCount": 0,
      "userLikes": true
}

DELETE

Delete a bookmarked entry.

Returns data about the deleted object.

Requirements

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

Permissions

Removing a bookmark for a sv:userIdentity requires that the sv:userIdentity is available, the caller is available, the caller is authorized to READ the sv:site and the caller is either the sv:userIdentity or is authorized to MANAGE_USER_IDENTITIES.
Removing a bookmark for a sv:collaborationGroup requires that the group is active, the caller is allowed to view the group, the caller is authorized to READ the sv:collaborationGroupPage and is authorized to either USE_COLLABORATION_GROUP or MANAGE_COLLABORATION_GROUP.

Parameters

Name	Type	Default	Values	Description	Since
messageFormat	`String`	HTML	HTML, PLAIN, JSON, JSON_TREE, MARKDOWN	The data format for the message in the returned result (JSON since 8, 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.
escapeMessage	`boolean`	false		HTML escape the message in the returned result (not applicable when messageFormat is PLAIN or MARKDOWN).	8

Example URL

400.4246245fa692dd1672f33/bookmarkedtimelineentries/428.314bac03169baa8557566

Example response

{
      "bookmarkId": "428.314bac03169baa8557566",
      "id": "420.264bac03169baa8557511",
      "creationDate": 1553615571265,
      "type": "entry",
      "author": {
         "id": "400.264bac03169baa855754",
         "fullName": "Leia Organa",
         "disabled": false,
         "BuddyIconSize_SMALL": "/images/200.95b3be916257bc215c3f4/19830930/princess.jpeg",
         "BuddyIconSize_LARGE": "/images/200.95b3be916257bc215c3f4/198309301/princess.jpeg",
         "BuddyIconSize_X_LARGE": "/images/200.95b3be916257bc215c3f5/198309302/princess.jpeg"
      },
      "isEditable": true,
      "isRemovable": true,
      "isBookmarkableInGroup": false,
      "isBookmarkable": true,
      "isLikable": true,
      "isSharable": true,
      "isCommentable": true,
      "message": "<p>Help me Sitevision. You’re my only hope</p>",
      "isModified": false,
      "likesCount": 405,
      "commentsCount": 0,
      "userLikes": true
}

Did you find the content on this page useful?

BookmarkedTimelineEntries REST API endpoint