SearchSettings

Last modified by Farooq Sheikh on 2020/01/02 10:17

SearchSettings

SearchSettings data structure used as input parameters of method ~/search for .

 

SearchSettings example
SearchSettings input request
{
  "FileInfo": {
    "FilePath": "string",
    "StorageName": "string",
    "VersionId": "string",
    "Password": "string"
  },   
  "SearchOptions":
   [
    {
        "DocumentType": "Pdf",
        "SignatureType": "Barcode",  
        "Page": 1,
        "Text": "123",
        "BarcodeType": "Code128",
        "MatchType": "Contains"
    }
   ]
 }
SearchSettings fields

Name

Description

API Version

FileInfo.FilePath

The path of the document, located in the storage. Required.

 

FileInfo.StorageName

Storage name

 

FileInfo.VersionId

File version Id

 

FileInfo.Password

Password for password-protected document to be signed.

 

SearchOptions

Array with at least one SearchOptions that specifies search options to provide search in the document for different signatures

 

 

 

Tags:
Created by Farooq Sheikh on 2020/01/02 10:17