...
API endpoints
SS01 | Store search
POST | /savedsearches |
|---|
User permission required
Supported Content Type(s)
- application/json
Remarks
- The JSON properties title, type and queryString must exist.
- The queryString must be encoded with Base64.
...
GET | /savedsearches |
|---|
User permission required
Supported Content Type(s)
- application/json
Remarks
- If no query params are set, then it returns all searches of user
...
PUT | /savedsearches/{id} |
|---|
User permission required
Supported Content Type(s)
- application/json
Remarks
- Only JSON properties title, type and queryString could be updated.
- If JSON properties are null or not present, they are not updated and existing values are kept.
Example: If you only set title, only the title property is updated. - The queryString must be encoded with Base64.
...
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"title": "Goethe",
"type": "newspaper",
"searchQuery": "aHR0cHM6Ly93aWtpLmRldXRzY2hlLWRpZ2l0YWxlLWJpYmxpb3RoZWsuZGUv"
} |
Supported Content Type(s)
- application/json
Status codes
- 204 = Search updated
- 400 = Wrong usage of endpoint
- 401 = User is not authorized
- 403 = Forbidden (User is not owner of Search)
- 404 = Search ID not found
- 500 = Internal server error
...
DELETE | /savedsearches/{id} |
|---|
User permission required
Supported Content Type(s)
- application/json
Status codes
- 204 = Search deleted (No content)
- 400 = Wrong usage of endpoint
- 401 = User is not authorized
- 403 = Forbidden (User is not owner of Search)
- 404 = Search ID not found
- 500 = Internal server error
...
...
Model
SavedSearch
Fields
| Field | Data type | Description |
|---|---|---|
id | Long | ID of the Saved Search (internal created by PostgreSQL) |
title | String | User defined title of the Saved Search |
type | String | Type of the Saved Search (CULTURAL_ITEM | INSTITUTION | ENTITY | NEWSPAPER(legacy)) |
queryString | String | Search query string with parameters filtered and sorted alphabetically. Encoded in Base64 |
userId | String | AAS/LDAP managed ID of the User |
createdAt | XMLGregorianCalendar | Creation date of the Saved Search created by the DDB Backend |
Description
- Model object to hold a Saved Search
...