[GH-ISSUE #30] Document further query parameters #18

New issue

Open

opened 2026-02-26 01:32:54 +03:00 by kerem · 3 comments

kerem commented

2026-02-26 01:32:54 +03:00

Owner

Originally created by @gbinal on GitHub (Mar 18, 2016).
Original GitHub issue: https://github.com/jeffknupp/sandman2/issues/30

Thanks for making such great code. I've got an instance running and am trying to document the ways that I can query the API.

So far, I've found:

?page=2
?[columnheader]=[value]
?[columnheader1]=[value1]&[columnheader3]=[value4] (returns results that have both value1 and value2)
?[columnheader1]=[value1]&[columnheader1]=[value2] (returns results that have value1 OR value2)

I've been trying to figure these but haven't had any luck:

set number of resources per page (e.g. ?limit=30)
search (e.g. ?q=value5)
sort (e.g. ?sort=-[columnhearder2])
exclude (e.g. ?[columnheader1]=[value1]&[columnheader3]=-[value4]) (return all entries that have value1 in columnheader1 but exclude those that have value4 in columnheader3).
return only certain fields (e.g. _?field=columnheader2)

I've looked pretty hard but sorry if I missed these being explained elsewhere. Thanks for any help with this.

Originally created by @gbinal on GitHub (Mar 18, 2016). Original GitHub issue: https://github.com/jeffknupp/sandman2/issues/30 Thanks for making such great code. I've got an instance running and am trying to document the ways that I can query the API. So far, I've found: - _?page=2_ - _?[columnheader]=[value]_ - _?[columnheader1]=[value1]&[columnheader3]=[value4]_ (returns results that have both value1 and value2) - _?[columnheader1]=[value1]&[columnheader1]=[value2]_ (returns results that have value1 OR value2) I've been trying to figure these but haven't had any luck: - set number of resources per page (e.g. _?limit=30_) - search (e.g. _?q=value5_) - sort (e.g. _?sort=-[columnhearder2]_) - exclude (e.g. _?[columnheader1]=[value1]&[columnheader3]=-[value4]_) (return all entries that have value1 in columnheader1 but exclude those that have value4 in columnheader3). - return only certain fields (e.g. _?field=columnheader2) I've looked pretty hard but sorry if I missed these being explained elsewhere. Thanks for any help with this.

kerem added the

enhancement

help wanted

labels

2026-02-26 01:32:54 +03:00

kerem commented

2026-02-26 01:32:54 +03:00

Author

Owner

@gbinal commented on GitHub (Mar 18, 2016):

@filmackay, @jeffknupp - Sorry, I saw the conversation here and am trying to use the queries outlined in this testfile for sort and limit. Just to confirm, though, are there query patterns I'm missing for these:

search (e.g. ?q=value5)
exclude (e.g. ?[columnheader1]=[value1]&[columnheader3]=-[value4]) (return all entries that have value1 in columnheader1 but exclude those that have value4 in columnheader3).
return only certain fields (e.g. _?field=columnheader2)

@gbinal commented on GitHub (Mar 18, 2016): @filmackay, @jeffknupp - Sorry, I saw [the conversation here](https://github.com/jeffknupp/sandman2/issues/23#issuecomment-173976581) and am trying to use the queries outlined in [this testfile](https://github.com/jeffknupp/sandman2/blob/master/tests/test_extended_functionality.py) for `sort` and `limit`. Just to confirm, though, are there query patterns I'm missing for these: - search (e.g. _?q=value5_) - exclude (e.g. _?[columnheader1]=[value1]&[columnheader3]=-[value4]_) (return all entries that have value1 in columnheader1 but exclude those that have value4 in columnheader3). - return only certain fields (e.g. _?field=columnheader2)

kerem commented

2026-02-26 01:32:54 +03:00

Author

Owner

@gbinal commented on GitHub (Mar 18, 2016):

P.S. Thanks for any help and thanks a bunch for making such a great project!

@gbinal commented on GitHub (Mar 18, 2016): P.S. Thanks for any help and thanks a bunch for making such a great project!

kerem commented

2026-02-26 01:32:55 +03:00

Author

Owner

@mcarans commented on GitHub (Feb 3, 2017):

Any progress on this?

@mcarans commented on GitHub (Feb 3, 2017): Any progress on this?

kerem referenced this issue

2026-02-26 01:33:14 +03:00

[PR #18] [CLOSED] Added support for comparison operators (other than equal) in querystring #103