Webservice: Enterprise Search

advanced search capabilities [Commercial editions only]

Index Method Request(s) Response Description
1 findDocumentsByParameters sid
templateId
criteria
order
maxResults
 hit Allows a user to retrieve all documents that match the list of criteria and that belong to the template with the given identifier. It retieves just regular documents.
2 findByParameters sid
templateId
criteria
order
maxResults
 hit Allows a user to retrieve all documents that match the list of criteria and that belong to the template with the given identifier. It retieves regular documents and aliases also.
3 queryDocuments sid
select
tables
where
order
maxResults
 Executes a query against the database to search documents. The query is select $select from ld_document DOC $tables where $where $order;

Method #1: findDocumentsByParameters

Allows a user to retrieve all documents that match the list of criteria and that belong to the template with the given identifier. It retieves just regular documents.

Request

Name Type Required Multiple Description
     sid
String Y
     templateId
Long Y
     criteria
WSCriterion Y Y
          field
String Y the criterion field. It can be: id, fileName, type, customId, version, publisher, creator, fileSize, lastModified, date, creation, rating, tags ...
          composition
String Y the criterion composition. It is always and
          operator
String Y the criterion operator. It can be: equals, notequal, contains, notcontains, greaterthan, lessthan, null, notnull, in, inorsubfolders
          stringValue
String the criterion value as string
          dateValue
Date the criterion value as date
          intValue
Long the criterion value as long
          doubleValue
Double the criterion value as double
          extendedAttribute
Int Y 1 if it refers to an extended attribute, 0 otherwise
          type
Int Y the criterion value type, 0=String, 1 = Integer, 2 = Double, 3 = Date, 4 = User, 5 = Boolean, 101 = Folder
     order
String optional order expression (eg. creation desc)
     maxResults
Integer maximum number of results

Response

Name Type Required Multiple Description
     hit
WSDocument Y Y
          id
Long Y unique identifier
          fileSize
Long Y
          status
Int 0 = unlocked, 1 = checked out, 2 = locked
          exportStatus
Int
          version
String
          fileVersion
String
          date
String Y last publication date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'
          publisher
String
          publisherId
Long
          creator
String
          creatorId
Long
          type
String Y
          lockUserId
Long
          creation
String the date when the document was created; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'
          fileName
String Y
          indexed
Int 0 = to index, 1 = indexed, 2 = skip indexing
          signed
Int
          stamped
Int 1 if the document contains at least one stamp
          tags
String Y tags applied to the document
          folderId
Long Y parent folder
          templateId
Long id of the template assigned to the document
          customId
String unique custom identifier
          immutable
Int 0 = not immutable, 1 = immutable
          digest
String
          exportName
String
          exportId
Long
          docRef
Long used for aliases, refers to another document
          docRefType
String if used, defines the reference type (use pdf for the PDF Conversion)
          deleteUserId
Long user that has deleted the document
          attributes
WSAttribute Y array of attributes
               name
String Y name of the attribute
               stringValue
String
               intValue
Long
               doubleValue
Double
               dateValue
String the date value; format must be 'yyyy-MM-dd'
               type
Int Y 0 = String, 1 = int, 2 = double, 3 = date, 4 = user (intValue represents the user's id), 5 = boolean (intValue must be 0 or 1), 6 = folder (intValue represents the folders's id)
               mandatory
Int Y
               hidden
Int Y
               position
Int
               label
String
               editor
Int Y 0 = free, 1 = preset
               setId
Long Id of the attribute set
               multiple
Int Y 0 = single value, 1 = one or more values
               parent
String The reference attribute name, used for multi value attributes
               stringValues
String Read only. In case of multiple string values, contains the values separated by a comma
          language
String language of the document; See specification
          summary
String contains the snippet search text
          score
Integer full text search score
          icon
String
          comment
String
          lastModified
String
          rating
Integer
          workflowStatus
String current workflow's status where the document is in
          workflowStatusDisplay
String current workflow's status display informations
          color
String optional color assigned to the document
          published
Int if it is not set to 1, the document is marked as not published
          startPublishing
String
          stopPublishing
String
          pages
Int number of pages (default 1)
          nature
Int 0 = document, 1 = form
          formId
Long the last modified date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'
          passwordProtected
Integer indicates whether the document is protected by a password
          ocrTemplateId
Long identifier of the Zonal OCR template to use to process this document
          ocrd
Int indicates if the document has been processed by the zonal OCR: 0 = to process, 1 = processed
          barcodeTemplateId
Long identifier of the barcode template to use to process this document
          barcoded
Int indicates if the document has been processed by the barcode processor: 0 = to process, 1 = processed

Method #2: findByParameters

Allows a user to retrieve all documents that match the list of criteria and that belong to the template with the given identifier. It retieves regular documents and aliases also.

Request

Name Type Required Multiple Description
     sid
String Y
     templateId
Long Y
     criteria
WSCriterion Y Y
          field
String Y the criterion field. It can be: id, fileName, type, customId, version, publisher, creator, fileSize, lastModified, date, creation, rating, tags ...
          composition
String Y the criterion composition. It is always and
          operator
String Y the criterion operator. It can be: equals, notequal, contains, notcontains, greaterthan, lessthan, null, notnull, in, inorsubfolders
          stringValue
String the criterion value as string
          dateValue
Date the criterion value as date
          intValue
Long the criterion value as long
          doubleValue
Double the criterion value as double
          extendedAttribute
Int Y 1 if it refers to an extended attribute, 0 otherwise
          type
Int Y the criterion value type, 0=String, 1 = Integer, 2 = Double, 3 = Date, 4 = User, 5 = Boolean, 101 = Folder
     order
String optional order expression (eg. creation desc)
     maxResults
Integer maximum number of results

Response

Name Type Required Multiple Description
     hit
WSDocument Y Y
          id
Long Y unique identifier
          fileSize
Long Y
          status
Int 0 = unlocked, 1 = checked out, 2 = locked
          exportStatus
Int
          version
String
          fileVersion
String
          date
String Y last publication date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'
          publisher
String
          publisherId
Long
          creator
String
          creatorId
Long
          type
String Y
          lockUserId
Long
          creation
String the date when the document was created; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'
          fileName
String Y
          indexed
Int 0 = to index, 1 = indexed, 2 = skip indexing
          signed
Int
          stamped
Int 1 if the document contains at least one stamp
          tags
String Y tags applied to the document
          folderId
Long Y parent folder
          templateId
Long id of the template assigned to the document
          customId
String unique custom identifier
          immutable
Int 0 = not immutable, 1 = immutable
          digest
String
          exportName
String
          exportId
Long
          docRef
Long used for aliases, refers to another document
          docRefType
String if used, defines the reference type (use pdf for the PDF Conversion)
          deleteUserId
Long user that has deleted the document
          attributes
WSAttribute Y array of attributes
               name
String Y name of the attribute
               stringValue
String
               intValue
Long
               doubleValue
Double
               dateValue
String the date value; format must be 'yyyy-MM-dd'
               type
Int Y 0 = String, 1 = int, 2 = double, 3 = date, 4 = user (intValue represents the user's id), 5 = boolean (intValue must be 0 or 1), 6 = folder (intValue represents the folders's id)
               mandatory
Int Y
               hidden
Int Y
               position
Int
               label
String
               editor
Int Y 0 = free, 1 = preset
               setId
Long Id of the attribute set
               multiple
Int Y 0 = single value, 1 = one or more values
               parent
String The reference attribute name, used for multi value attributes
               stringValues
String Read only. In case of multiple string values, contains the values separated by a comma
          language
String language of the document; See specification
          summary
String contains the snippet search text
          score
Integer full text search score
          icon
String
          comment
String
          lastModified
String
          rating
Integer
          workflowStatus
String current workflow's status where the document is in
          workflowStatusDisplay
String current workflow's status display informations
          color
String optional color assigned to the document
          published
Int if it is not set to 1, the document is marked as not published
          startPublishing
String
          stopPublishing
String
          pages
Int number of pages (default 1)
          nature
Int 0 = document, 1 = form
          formId
Long the last modified date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'
          passwordProtected
Integer indicates whether the document is protected by a password
          ocrTemplateId
Long identifier of the Zonal OCR template to use to process this document
          ocrd
Int indicates if the document has been processed by the zonal OCR: 0 = to process, 1 = processed
          barcodeTemplateId
Long identifier of the barcode template to use to process this document
          barcoded
Int indicates if the document has been processed by the barcode processor: 0 = to process, 1 = processed

Method #3: queryDocuments

Executes a query against the database to search documents. The query is <b>select</b> $select <b>from ld_document DOC</b> $tables <b>where</b> $where $order<b>;</b>

Request

Name Type Required Multiple Description
     sid
String Y
     select
String columns to return
     tables
String additional tables to join with ld_doument
     where
String Y query conditions
     order
String optional clause for ordering or grouping the results
     maxResults
Integer maximum number of results

Response

Name Type Required Multiple Description
    
FreemarkerWebServiceDisplayer$UnkownType Y Y