...
...
FA02 | Retrieve bookmark
GET | /favourites/bookmarks/{id} |
|---|
User permission required
Response payload
...
FA03 | Retrieve bookmarks
GET | /favourites/bookmarks |
|---|
User permission required
Query parameters
| Name | Value | Occurence | Default |
|---|---|---|---|
| folderIds | ID of folder(s) | Multiple | - |
Response payload
Returns BookmarkResult JSON object:
...
...
FA04 | Update bookmark
PUT | /favourites/bookmarks/{id} |
|---|
User permission required
Remarks
- The parameter folderId defines all lists (folders) to add the bookmark.
- Duplicates for folderIds are not possible because of using a set.
- The folderId favorites is always used. If no folderId is specified, only favorites is used.
- If the folder favorites not exists, because a new user adds the first bookmark, then the folder favorites is created.
Query parameters
| Name | Value | Occurence | Default |
|---|---|---|---|
| userId | ID of user | Once | - |
| itemIds | List of IDs | Multiple | - |
| offset | Beginn offset of results | Once | -1 |
| size | Size data of results | Once | -1 |
Request payload
Returns Bookmark JSON object:
...
...
FA05 | Delete bookmark
DELETE | /favourites/bookmarks/{id} |
|---|
User permission required
Query parameters
| Name | Value | Occurence | Default |
|---|---|---|---|
| folderIds | ID of folder(s) | Multiple | - |
Status codes
- 200 = Bookmark deleted
- 401 = User is not authorized
- 404 = Bookmark ID not found
- 500 = Internal server error
...
- UC06 | Delete bookmarks in All Favorites
- A user deletes a bookmark from favorites (and the rest of the lists).
- A user deletes a bookmark from favorites (and the rest of the lists).
...
FA06 | Create folder
POST | /favourites/folders |
|---|
User permission required
Request payload
...
FA07 | Add bookmark to folder
POST | /favourites/{id}/bookmarks |
|---|
User permission required
Remarks
- A bookmark could not be added to the main folder (favorites), because it is added to this folder when you create a bookmark.
- The folder ID and bookmark ID must exist before adding something.
Query parameters
| Name | Value | Occurence | Default |
|---|---|---|---|
| bookmarkId | ID of bookmark to add | Once | - |
Status codes
- 200 = Bookmarks added
- 400 = Bookmark ID not exist
- 401 = User is not authorized
- 404 = Folder ID not exist
- 500 = Internal server error
...
...
FA08 | Retrieve folder
GET | /favourites/folders/{id} |
|---|
User permission required
Response payload
...
FA09 | Retrieve bookmarks of a folder
GET | /favourites/folders/{id}/bookmarks |
|---|
User permission required
Response payload
...
...
FA10 | Retrieve folders
GET | /favourites/folders |
|---|
User permission required
Query parameters
| Name | Value | Occurence | Default |
|---|---|---|---|
| userId | ID of user | Once | - |
| title | Title of folder | Once | - |
| offset | Beginn offset of results | Once | -1 |
| size | Size data of results | Once | -1 |
Response payload
Returns FolderResult JSON object:
...
...
FA11 | Update folder
POST | /favourites/folders/{id} |
|---|
User permission required
Query parameters
| Name | Value | Occurence |
|---|---|---|
| folderIds | ID of folder(s) | Multiple |
Request payload
Returns Folder JSON object:
...
...
FA12 | Delete folder
DELETE | /favourites/folders/{id} |
|---|
User permission required
Query parameters
| Name | Value | Occurence |
|---|---|---|
| folderIds | ID of folder(s) | Multiple |
Status codes
- 200 = Folder deleted
- 400 = Folder favorite could not be deleted
- 401 = User not authorized
- 404 = Folder ID not found
- 500 = Internal server error
...
FA13 | Delete bookmark from folder
DELETE | /favourites/folders/{id}/bookmarks/{bookmarkId} |
|---|
User permission required
Remarks
...
FA14 | Delete all bookmarks and folders
DELETE | /favourites/folders |
|---|
User permission required
Query parameters
| Name | Value | Occurence | Default |
|---|---|---|---|
| userId | ID of user to delete | Once | - |
Status codes
- 200 = Bookmarks and Folders deleted
- 401 = User not authorized
- 404 = User ID not found
- 500 = Internal server error
...
Bookmark's KeywordTool
Fields
| Field | Data type | Description |
|---|---|---|
| Done | Boolean | Used in APD |
Description
- Model object to hold and transfer APD internal data
...
...
BookmarkResult
Fields
| Field | Data type | Description |
|---|---|---|
query | String | Summary of the executed query (for debugging use) |
total | Long | Total matches |
offset | Long | Used offset (default or send by the request) |
size | Long | Used size (default or send by the request) |
bookmarks | List<Bookmark> | List of the found bookmarks by the query |
Description
- Model object to hold bookmarks (depends of offset and size) by the query
...
...
Folder
Fields
| Field | Data type | Description |
|---|---|---|
id | String | ID of the folder (internal created by Elasticsearch) |
title | String | Title of the user list |
description | String | User defined text to describe the list |
userId | String | AAS/LDAP managed ID of the User |
publishingName | String | User Identifier if the list is published |
createdAt | Long | Creation date of the folder in millis created by the DDB Backend |
updateAt | Long | Last Update date of the folder in millis created by the DDB Backend |
bookmarkIds | Set<String> | List of related bookmarks IDs |
institutionIds | Set<String> | List of related institution IDs |
blockingToken | String | Optional token for internal use in APD |
blocked | Boolean | If the list is blocked for public use |
published | Boolean | If the list is published for public use |
keywordTool | KeywordTool | Optional data for internal use in APD (for keyword tool) |
Description
- Model object to hold a folder (= favorites list and user defined lists)
...
Folder's KeywordTool
Fields
| Field | Data type | Description |
|---|---|---|
sentToAdmin | Boolean | Used in APD |
Description
- Model object to hold and transfer APD internal data
...
...
FolderResult
Fields
| Field | Data type | Description |
|---|---|---|
query | String | Summary of the executed query (for debugging use) |
total | Long | Total matches |
offset | Long | Used offset (default or send by the request) |
size | Long | Used size (default or send by the request) |
folders | List<Folder> | List of the found folders by the query |
Description
- Model object to hold found folders (depends of offset and size) by the query
...