Webservice: Search

---

Method #1: find

performs a search by the search options

Request

Name		Type		Required		Multiple		Description
sid		String		Y				identifier of the session
options		WSSearchOptions		Y
maxHits		Int		Y
type		Int		Y
expression		String		Y
name		String		Y
description		String		Y
topOperator		String		Y
caseSensitive		Int		Y
retrieveAliases		Int		Y
filterIds		Long		Y		Y
folderId		Long		Y
searchInSubPath		Int		Y
expressionLanguage		String		Y
sizeMin		Long		Y
sizeMax		Long		Y
format		String		Y
fields		String		Y		Y
language		String		Y
dateFrom		String		Y
dateTo		String		Y
creationFrom		String		Y
creationTo		String		Y
template		Long		Y

Response

Name		Type		Required		Multiple		Description
searchResult		WSSearchResult		Y
time		Long		Y
estimatedHitsNumber		Long		Y
hits		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
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
moreHits		Int		Y
totalHits		Int		Y

---

Method #2: findFolders

finds authorized folders for the current user containing the given name (like '%' operator is used)

Request

Name		Type		Required		Multiple		Description
sid		String		Y				identifier of the session
name		String		Y

Response

Name		Type		Required		Multiple		Description
folder		WSFolder		Y		Y
id		Long		Y				unique identifier of the folder
name		String		Y
parentId		Long		Y				identifier of the parent folder
description		String		Y
lastModified		String						the last modified date (format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd')
type		Int		Y				0 = Folder, 1 = Workspace
templateId		Long						template assigned to folder
templateLocked		Int		Y				0 = the template is unlocked, 1 = the template is locked
creation		String						the creation date (format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd')
creator		String						who created the folder
position		Int		Y
hidden		Int		Y				0 = visible, 1 = hidden
foldRef		Long						the referenced folder, used in case of folder alias
securityRef		Long						another folder to inherit the security from
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
storage		Integer						the storage to use for new files. Valid only in case of workspace.
tags		String				Y		tags applied to the document
ocrTemplateId		Long						identifier of the Zonal OCR template to use to process the documents inside this folder
barcodeTemplateId		Long						identifier of the barcode template to use to process the documents inside this folder

---

Method #3: findByFilename

finds authorized documents for the current user with the given filename (like '%' operator is used)

Request

Name		Type		Required		Multiple		Description
sid		String		Y				identifier of the session
filename		String		Y

Response

Name		Type		Required		Multiple		Description
document		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
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