POST | /favourites/bookmarks |
---|
User permission required
Name | Value | Occurence | Default |
---|---|---|---|
folderIds | ID of folder(s) | Multiple | - |
{ "id": "rjzgAIgBdHmpxQQKvQHm", "itemId": "IVMX3IRHKU725WR2HHT6VY2AFFS72FGK", "description": "My important description", "userId": "fachstelle_museum", "type": "CULTURAL_ITEM", "createdAt": 1683641908448, "updatedAt": 1683641908448, "keywordTool": { "done": True } } |
GET | /favourites/bookmarks/{id} |
---|
User permission required
{ "id": "rjzgAIgBdHmpxQQKvQHm", "itemId": "IVMX3IRHKU725WR2HHT6VY2AFFS72FGK", "description": "My important description", "userId": "fachstelle_museum", "type": "CULTURAL_ITEM", "createdAt": 1683641908448, "updatedAt": 1683641908448, "keywordTool": { "done": True } } |
GET | /favourites/bookmarks |
---|
User permission required
Name | Value | Occurence | Default |
---|---|---|---|
userId | ID of user | Once | - |
itemIds | IDs of items | Multiple | - |
offset | Offset of result | Once | -1 |
size | Length of result | Once | -1 |
{ "query": "user:"73611165cc142ae53176707d5a92e8f3", "total": 4, "offset": 0, "size": 9999, "bookmarks": [ { "id": "rjzgAIgBdHmpxQQKvQHm", "itemId": "IVMX3IRHKU725WR2HHT6VY2AFFS72FGK", "description": "", "userId": "fachstelle_museum", "type": "CULTURAL_ITEM", "createdAt": 1683641908448, "updatedAt": 1683641908448, "keywordTool": { "done": False }, }, { "id": "nDxWtIgBdHmpxQQKNxNQ", "itemId": "IVMX3IRHKU725WR2HHT6VY2AFFS72FGK", "description": "Neues Lesezeichen", "userId": "fachstelle_museum", "type": "CULTURAL_ITEM", "createdAt": 1683641908448, "updatedAt": 1683641908448, "keywordTool": { "done": False }, } ] } |
PUT | /favourites/bookmarks/{id} |
---|
User permission required
{ "id": "rjzgAIgBdHmpxQQKvQHm", // Not used "itemId": "IVMX3IRHKU725WR2HHT6VY2AFFS72FGK", // Not used "description": "Another description", // Optional "userId": "fachstelle_museum", // Not used "type": "INSTITUTION", // Optional "createdAt": 1683641908448, // Not used "updatedAt": 1683641908448, // Not used "keywordTool": { // Optional "done": false } } |
{ "id": "rjzgAIgBdHmpxQQKvQHm", "itemId": "IVMX3IRHKU725WR2HHT6VY2AFFS72FGK", "description": "Another description", "userId": "fachstelle_museum", "type": "INSTITUTION", "createdAt": 1683641908448, "updatedAt": 1683641908555, "keywordTool": { "done": false } } |
DELETE | /favourites/bookmarks/{id} |
---|
User permission required
POST | /favourites/folders |
---|
User permission required
{ "id": "73611165cc142ae53176707d5a92e8f3", // Not used "portal": "DDB", // Required "title": "favorites", // Required "description": "Das ist ein Test!", // Optional "userId": "fachstelle_museum", // Not used "publishingName": "xxx", // Optional "createdAt": 1682070216141, // Not used "updatedAt": 1683642142482, // Not used "bookmarkIds": [ // Optional "MESR_IcBosJ3rUWzhkJj", "rjzgAIgBdHmpxQQKvQHm" ], "institutionIds": [ // Optional "MESR_IcBosJ3rUWzhkJj" ], "blockingToken": "Test", // Optional "blocked": true, // Optional "published": true, // Optional "keywordTool": { // Optional "sentToAdmin": false } } |
{ "id": "73611165cc142ae53176707d5a92e8f3" "portal": "DDB", "title": "favorites", "description": "Das ist ein Test!", "userId": "fachstelle_museum", "publishingName": "xxx", "createdAt": 1682070216141, "updatedAt": 1683642142482, "bookmarksIds": [ "MESR_IcBosJ3rUWzhkJj", "rjzgAIgBdHmpxQQKvQHm" ], "institutionIds": [ "MESR_IcBosJ3rUWzhkJj" ], "blockingToken": "Test", "blocked": true, "published": true, "keywordTool": { "sentToAdmin": false } } |
POST | /favourites/{id}/bookmarks |
---|
User permission required
Name | Value | Occurence | Default |
---|---|---|---|
bookmarkId | ID of bookmark to add | Once | - |
GET | /favourites/folders/{id} |
---|
User permission required
{ "id": "73611165cc142ae53176707d5a92e8f3" "title": "favorites", "description": "Das ist ein Test!", "userId": "fachstelle_museum", "publishingName": "xxx", "createdAt": 1682070216141, "updatedAt": 1683642142482, "bookmarksIds": [ "MESR_IcBosJ3rUWzhkJj", "rjzgAIgBdHmpxQQKvQHm" ], "institutionIds": [ "MESR_IcBosJ3rUWzhkJj" ], "blockingToken": "Test", "blocked": true, "published": true, "keywordTool": { "sentToAdmin": false } } |
GET | /favourites/folders/{id}/bookmarks |
---|
User permission required
{ "query": "user:"73611165cc142ae53176707d5a92e8f3" AND folder:"p0Qyo4cBosJ3rUWznjiY"", "total": 4, "offset": 0, "size": 9999, "bookmarks": [ { "id": "rjzgAIgBdHmpxQQKvQHm", "itemId": "IVMX3IRHKU725WR2HHT6VY2AFFS72FGK", "description": "", "userId": "fachstelle_museum", "type": "CULTURAL_ITEM", "createdAt": 1683641908448, "updatedAt": 1683641908448, "keywordTool": { "done": False }, }, { "id": "nDxWtIgBdHmpxQQKNxNQ", "itemId": "IVMX3IRHKU725WR2HHT6VY2AFFS72FGK", "description": "Neues Lesezeichen", "userId": "fachstelle_museum", "type": "CULTURAL_ITEM", "createdAt": 1683641908448, "updatedAt": 1683641908448, "keywordTool": { "done": False }, } ] } |
GET | /favourites/folders |
---|
User permission required
Name | Value | Occurence | Default |
---|---|---|---|
userId | ID of user | Once | - |
portal | Name of used portal | Once | DDB |
title | Title of folder | Once | - |
offset | Beginn offset of results | Once | -1 |
size | Size data of results | Once | -1 |
{ "query": "user:"73611165cc142ae53176707d5a92e8f3"", "total": 19, "offset": 0, "size": 9999, "folders": [ { "id": "Sjszo4cBdHmpxQQKUvah", "portal": "DDB", "title": "Schiller", "description": "", "userId": "fachstelle_museum", "publishingName": "dio", "createdAt": 1682070262371, "updatedAt": 1683642142787, "bookmarksIds": ["MUSR_IcBosJ3rUWzmkLU"], "institutionIds": Null, "blockingToken": "", "keywordTool": { "sentToAdmin": false }, "blocked": false, "published": true}, { "id": "rjwQKYgBdHmpxQQKKgSs", "portal": "DDB", "title": "favorites", "description": "Das ist ein Test!", "userId": "fachstelle_museum", "publishingName": "xxx", "createdAt": 1682070216141, "updatedAt": 1683642142482, "bookmarksIds": [], "institutionIds": none, "blockingToken": "Test", "keywordTool": { "sentToAdmin": false }, "blocked": true, "published": true } ] } |
POST | /favourites/folders/{id} |
---|
User permission required
{ "id": "Sjszo4cBdHmpxQQKUvah", // Not used "title": "favorites", // Optional "description": "Das ist ein Test!", // Optional "userId": "fachstelle_museum", // Not used "publishingName": "xxx", // Optional "createdAt": 1682070216141, // Not used "updatedAt": 1683642142482, // Not used "bookmarksIds": [ // Optional "MESR_IcBosJ3rUWzhkJj", "rjzgAIgBdHmpxQQKvQHm" ], "institutionIds": [ // Optional "MESR_IcBosJ3rUWzhkJj" ], "blockingToken": "Test", // Optional "blocked": true, // Optional "published": true, // Optional "keywordTool": { // Optional "sentToAdmin": false } } |
{ "id": "Sjszo4cBdHmpxQQKUvah", "title": "favorites", "description": "Das ist ein Test!", "userId": "fachstelle_museum", "publishingName": "xxx", "createdAt": 1682070216141, "updatedAt": 1683642142482, "bookmarksIds": [ "MESR_IcBosJ3rUWzhkJj", "rjzgAIgBdHmpxQQKvQHm" ], "institutionIds": [ "MESR_IcBosJ3rUWzhkJj" ], "blockingToken": "Test", "blocked": true, "published": true, "keywordTool": { "sentToAdmin": false } } |
DELETE | /favourites/folders/{id} |
---|
User permission required
DELETE | /favourites/folders/{id}/bookmarks/{bookmarkId} |
---|
User permission required
DELETE | /favourites/folders |
---|
User permission required
Name | Value | Occurence | Default |
---|---|---|---|
userId | ID of user to delete | Once | - |
Field | Data type | Description |
---|---|---|
id | String | ID of the bookmark (internal created by Elasticsearch) |
itemId | String | ID of the DDB object item |
description | String | User defined text to describe the list |
userId | String | AAS/LDAP managed ID of the User |
bookmarkType | String | Type of the bookmark |
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 |
keywordTool | KeywordTool | Optional data for internal use in APD (for keyword tool) |
Field | Data type | Description |
---|---|---|
Done | Boolean | Used in APD |
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 |
Field | Data type | Description |
---|---|---|
id | String | ID of the folder (internal created by Elasticsearch) |
portal | Portal enum | Name of used portal |
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) |
Field | Data type | Description |
---|---|---|
sentToAdmin | Boolean | Used in APD |
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 |
Value | Description |
---|---|
DDB | DDB Portal with CCC |
NEWSPAPER | Zeitungsportal |