com.laserfiche.repository.api.clients

Interface SimpleSearchesClient

All Known Implementing Classes:

SimpleSearchesClientImpl

public interface SimpleSearchesClient

The Laserfiche Repository SimpleSearches API client.

Method Summary

Modifier and Type	Method and Description
EntryCollectionResponse	searchEntry(ParametersForSearchEntry parameters) - Runs a "simple" search operation on the repository. - Returns a truncated search result listing. - Search result listing may be truncated, depending on number of results.

Method Detail

searchEntry

EntryCollectionResponse searchEntry(ParametersForSearchEntry parameters)

- Runs a "simple" search operation on the repository.
- Returns a truncated search result listing.
- Search result listing may be truncated, depending on number of results. Additionally, searches may time out if they take too long. Use the other search route to run full searches.
- Optionally returns field values for the entries in the folder. Each field name needs to be specified in the request. Maximum limit of 10 field names. If field values are requested, only the first value is returned if it is a multi value field. The remaining field values can be retrieved via the GET fields route. Null or Empty field values should not be used to determine if a field is assigned to the entry.
- Required OAuth scope: repository.Read

Parameters:

parameters - An object of type ParametersForSearchEntry which encapsulates the parameters of searchEntry method.

Returns:

EntryCollectionResponse The return value