Schema for Rest API for v1.5.3 on GitHub ?

  • Dave Walton

    Dave Walton - 2014-05-29


    I am reading the api on to start testing this api (new user). Does this site have the full schema so that I can see what it supports for fields. The help pages on the right for specific things (e.g. search) are great ...., however if I want to see how to do specific things it is time-consuming to try find an example. I have resorted to running queries and seeing the errors:-(.

    Specifically, I am trying to test filters added to a JSON POST data. Is this right , as it passed OK but returns no data when it expected it to.

    "filters": [
        "type": "TermFilter",
        "field": "BookReference",
        "term": "search data",
        "negative": false

    Is there a button on the main console that can pop up the JSON POST data for whatever query I am testing manually, that would help me analyse the specific calls I need to make in my JSON


    ps. I saw 1 filter example but not exactly what i wanted so i guessed.

  • Emmanuel Keller

    Emmanuel Keller - 2014-05-29

    Hi Dave,

    Here is a simple way to know the JSON syntax.

    First, build the query in the user interface.

    Then use this API to retrieve the JSON structure:

    Finally, reuse this syntax to build your own JSON query.

    Last edit: Emmanuel Keller 2014-05-30
  • Dave Walton

    Dave Walton - 2014-05-30

    Thanks, great, exactly what I was looking for. although the link is bad,:-), but has relevant details.

    By the way, in regards to terminology, template basically means a query template including entire definition of the query, right ? There are no other sorts of templates, right?
    In ESP/MS search it only referred to the "returnedFields" bit of the query with other fields applied on the fly.



Get latest updates about Open Source Projects, Conferences and News.

Sign up for the SourceForge newsletter:

No, thanks