- Home
- Resources
- BookmarkResource
The Bookmark resource provides access to user bookmarks in InService.
Data Model Objects
The following resources are applicable:
GET /bookmarks
Gets a list of user bookmarks.
Note that this endpoint does not have to be ever called as long as appropriate expand
parameter is used when fetching user information. For more info see UserResource.
Response Codes
| code |
condition |
| 404 |
if no user bookmarks are found |
Response Body
| media type |
data type |
| application/vnd.ptc.sc+json |
SCList
(JSON) |
POST /bookmarks/location
Gets a stored user bookmark that points to location specified by bookmarkInfo SCItem.
This SCItem has the same format and should contain the same data as a regular creation
bookmark SCItem that is passed in addBookmarks endpoint.
Request Body
| media type |
data type |
| application/vnd.ptc.sc+json |
SCItem
(JSON) |
Response Body
| media type |
data type |
| application/vnd.ptc.sc+json |
SCItem
(JSON) |
PUT /bookmarks
Adds new user bookmarks as specified, and returns list of all bookmarks after the new ones are added.
Request Body
| media type |
data type |
description |
| application/vnd.ptc.sc+json |
SCList
(JSON) |
The SCList of bookmarks to be added. |
Response Body
| media type |
data type |
| application/vnd.ptc.sc+json |
SCList
(JSON) |
POST /bookmarks
Updates the specified bookmarks with new data. Other bookmarks will be left unchanged.
Request Body
| media type |
data type |
description |
| application/vnd.ptc.sc+json |
SCList
(JSON) |
The SCList of bookmarks to be updated. |
Response Body
| media type |
data type |
| application/vnd.ptc.sc+json |
SCList
(JSON) |
DELETE /bookmarks
Deletes user bookmarks as specified, and returns list of all bookmarks that were left after deletion.
Request Body
| media type |
data type |
description |
| application/vnd.ptc.sc+json |
SCList
(JSON) |
The SCList of bookmarks to be deleted. |
Response Body
| media type |
data type |
| application/vnd.ptc.sc+json |
SCList
(JSON) |