Thursday, 19 September 2013

Although we just released soapgate Q! 4.5, release 5 is already well on the way...

Release 5 is all about RESTful services and JSON.

As a first step we will provide for (almost) all SOAP operations available so far the equivalent RESTful operation. As part of this development we decided to speak JSON only.

In version 5 the implementation will be a wrapper around the existing web services, so the performance gain of REST compared to SOAP will not be as great as it could be. However, release 6 will bring a complete overhaul of the underlying web service code, which will result in all service operations (RESTful and SOAP) to return JSON formatted data.

The following URLs are a sample on how the RESTful interface will work...

  1. dbViewEntries (which is the equivalent to dbView2XML)

    http://domino.flexdomino.net/SOAPGATEQ_5.NSF/REST4ViewsFolders?openagent&OPERATION=dbviewentries&SRVNAME=flexdomino/flex2domino&DBNAME=flex/flexdemo.nsf&VIEWNAME=books.flat
  2. dbViewEntries with additional parameters (first 10 rows and the view entry number for paging)

    http://domino.flexdomino.net/SOAPGATEQ_5.NSF/REST4ViewsFolders?openagent&OPERATION=dbviewentries&SRVNAME=flexdomino/flex2domino&DBNAME=flex/flexdemo.nsf&VIEWNAME=books.flat&rows=10&retVENUM=true
  3. dbViewEntries with additional parameters (next 10 rows and the document UNID)

    http://domino.flexdomino.net/SOAPGATEQ_5.NSF/REST4ViewsFolders?openagent&OPERATION=dbviewentries&SRVNAME=flexdomino/flex2domino&DBNAME=flex/flexdemo.nsf&VIEWNAME=books.flat&rows=10&retVENUM=true&direct=1&startpos=10&retUNID=true
  4. dbColumnX

    http://domino.flexdomino.net/SOAPGATEQ_5.NSF/REST4ViewsFolders?openagent&OPERATION=dbcolumnx&SRVNAME=flexdomino/flex2domino&DBNAME=flex/flexdemo.nsf&VIEWNAME=books.flat&colfields=1~2~3~4~5
  5. dbLookupX

    http://domino.flexdomino.net/SOAPGATEQ_5.NSF/REST4ViewsFolders?openagent&OPERATION=dblookupx&SRVNAME=flexdomino/flex2domino&DBNAME=flex/flexdemo.nsf&VIEWNAME=books.flat&colfields=1~2~3~4~5&keys=entertainment&retUNID=true

3 comments:

  1. Ooops, we removed anonymous access for testing purposes and forgot to allow it again.

    In any case, if it happens again, you can use

    User: online demo
    Password: demo

    ReplyDelete
  2. is there any API document available for the latest version?

    ReplyDelete
  3. The documentation is unfortunately not ready yet. This effects mostly the RESTful services The SOAP part is pretty good documented. ETA for the complete new manuals is end of April 2015. There are however release notes in the download package and the sample request posted here. If you have any questions to the RESTful services sent an email to mwille @ flexdomino . net

    ReplyDelete