Page History

Versions Compared

Key

This line was added.
This line was removed.
Formatting was changed.

...

PUT	/savedsearches/{id}

User permission required

Request payload

Code Block

theme	Midnight
title	SavedSearch object
linenumbers	true
collapse	true

...

Remarks

Only JSON properties title, type and queryString could be updated.
If a JSON property is null, it is not updated and the existing values are kept.
Example: If you only set title, only the title property is updated.

Request payload

Code Block

theme	Midnight
title	SavedSearch object
linenumbers	true
collapse	true

-{
    "title": "Goethe",
    "type": "newspaper",
    "searchQuery": "aHR0cHM6Ly93aWtpLmRldXRzY2hlLWRpZ2l0YWxlLWJpYmxpb3RoZWsuZGUv"
}

Status codes

200 204 = Bookmark updated
400 = Wrong usage of endpoint
401 = User is not authorized
403 = Forbidden (User is not owner of Search)
404 = Bookmark ID not found
500 = Internal server error

Example call(s)

Update search
- ?PUT https://dev-ddb.fiz-karlsruhe.de/api/2/savedsearches/123456

^ Back to top

...

SS04 | Delete search

...

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

...