Use this strategy to select documents from the view by key. The view will be searched by the first sorted column.

Allowed method

Parameters:

 

Let's assume our database has view called (ByTopic), that contains first sorted column displaying Topic field.

Notice the {filterValue} part of the first line bellow. This is placeholder for where SmartNSF expects to read parameter value for keyVariableName from, see line 4.

router.GET('topics/filter/{filterValue}') {
   strategy(DOCUMENTS_FROM_VIEW_BY_KEY) {
      viewName('(ByTopic)')
      keyVariableName('filterValue')
   }
   mapJson 'id', json:'id', type:'STRING', isformula:true, formula:'@DocumentUniqueID'
   mapJson 'date_created', json:'date_created', type:'DATETIME', isformula:true, formula:'@Created'
   mapJson 'topic', json:'topic', type:'STRING'
   mapJson 'author', json:'author', type:'STRING', isformula:true, formula:'@Name([CN]; @Author)'
}

 

With route defined above, URL http://server.name/path-to/db.nsf/xsp/.xrest/topics/filter/test will return all documents from view (ByTopic) with field Topic starting with "test".

 

For example, if only one document matches this filter, we'll get this JSON:

    {
        "author": "Martin Jinoch",
        "id": "54502859C07299C7C12580D8006404F4",
        "date_created": "2017-03-03T11:01+00:00",
        "topic": "test"
    }

 

Related articles

Related articles appear here based on the labels you select. Click to edit the macro and add or change labels.

Related issues