Agnostic Guides
...
Developers Guide
Box Endpoints
Search
1min
Link Enterprise provides a web service endpoint that will allow you to retrieve a subset of documents/folders based on a search criteria. Link Enterprise supports two types of search within box. One using metadata filters and another using metadata queries (real-time).
To enable or disable metadata queries (real-time search) you can do so within the Link Enterprise 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
required
String
Name of the box system configured in Link Enterprise .
whereClause
required
String
A where clause (JSON in string form). Used to query box to return a set of files/folders depending on criteria set.
selectedCMS
required
String
Value should always be set to "box" to let Link Enterprise 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
required
String
Name of the box system configured in Link Enterprise .
whereClause
optional
String
A where clause (JSON in string form). Used to query box to return a set of files/folders depending on criteria set.
selectedCMS
optional
String
Value should always be set to "box" to let Link Enterprise know which configured content system to search.