Skip to content

Contract for findItemsWithEdit search method #210

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Contract for findItemsWithEdit search method #210

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1e6ecb1
Add Item search method: findItemsWithEdit
ybnd Dec 23, 2022
7c42266
findItemsWithEdit: add HTTP 401 response
ybnd Jan 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions items.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -551,3 +551,17 @@ Return codes:
* 401 Unauthorized - if you are not authenticated
* 403 Forbidden - if you are not logged in with sufficient permissions
* 404 Not found - if the item doesn't exist (or was already deleted)

## Search methods
### findItemsWithEdit
**GET /api/core/items/search/findItemsWithEdit**

The supported parameters are:
* `query`: limit the returned Items to those with metadata values matching the query terms.
* `page`, `size` [see pagination](README.md#Pagination)

It returns the list of Items that the current user is authorized to edit

Return codes:
* 200 OK - if the operation succeeds
* 401 Unauthorized - if you are not authenticated