Agnostic Guides
...
docuflow SCRUD Web Services
Box Endpoints
Search
2min
Docuflow provides a web service endpoint that will allow you to retrieve a subset of documents/folders based on a search criteria. Docuflow supports two types of search within box. One using metadata filters and another using metadata queries (real-time).
You can learn about the pros and cons of which one to utilize here.
To enable or disable metadata queries (real-time search) you can do so within the docuflow configurator interface.
We are providing below an example of both a metadata filter example (with search query disabled in the configurator), and a metadata query example (with search query enabled in the configurator).
Search for all documents using a where clause. If succesfull will return a JSON Array with a size greater then or equal to zero with status code of 200. Otherwise status code 500 is returned.
Precondition: insertName.searchQueryEnabled=true (located in inifile)
POST
Request
Body Parameters
cmsName
String
required
Name of the box system configured in docuflow.
whereClause
String
required
A where clause (JSON in string form). Used to query box to return a set of files/folders depending on criteria set.
selectedCMS
String
required
Value should always be set to "box" to let docuflow know which configured content system to search.
Search for all files/folders using a where clause. If succesfull will return a JSON Array with a size greater then or equal to zero with status code of 200. Otherwise status code 500 is returned.
POST
Request
Body Parameters
cmsName
String
required
Name of the box system configured in docuflow.
whereClause
String
optional
A where clause (JSON in string form). Used to query box to return a set of files/folders depending on criteria set.
selectedCMS
String
optional
Value should always be set to "box" to let docuflow know which configured content system to search.
