SearchInDocuments

 

Description

Performs a search in the entire database in OCR text, then returns with the list of documents where the search term is found.

Method Type

POST

URL         

api/ocr/search-documents

Parameters

Name

Type

Description

Filter (Optional)

String

Document name filter

SearchTerm (Optional)

String

The search term.

CE (Optional)

String

The Specified Content-Engine.

 

Possible values:

0: Default Content-Engine (default)

1: FileEngine

2: DatabaseEngine

Response Type

JSON (JsonResult)

Return values

{

documents (List<DocumentManagement.Document>)

}

 

Programming notes

The API will combine the received User, Filter and SearchTerm parameters. This means, that the API will return only the documents, which are accessible for the User and where the document name contains the Filter and where the Search Term found in the stored OCR text.

The API will automatically read the OCRDatabaseType value from the appsettings.json file, and decide if the OCR must be queried from the SQL, or from the ODBC database.

 

Example

None

 

Requirements