Skip to content
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.

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

Document further query parameters #30

Open
gbinal opened this issue Mar 18, 2016 · 3 comments
Open

Document further query parameters #30

gbinal opened this issue Mar 18, 2016 · 3 comments

Comments

@gbinal
Copy link

@gbinal gbinal commented Mar 18, 2016

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.

@gbinal
Copy link
Author

@gbinal gbinal commented 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
Copy link
Author

@gbinal gbinal commented Mar 18, 2016

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

@mcarans
Copy link

@mcarans mcarans commented Feb 3, 2017

Any progress on this?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
3 participants
You can’t perform that action at this time.