Objective

Returns document numbers of all documents retrieved by the search. It is possible to filter results with the “properties” parameter. DST must be provided in the DST method version.

Parameters

ParameterDescriptionType
libraryeDOCS libraryString
userUser nameString
passwordUser passwordString
formThe name of the form.String
propertiesAll of the properties must be passed as a string. To get all documents named “eDOCS IS”:
eDOCS IS

Wildcards as “*” are allowed and the search is case insensitive.

*info*
*IN*12608690
*O*MS WORD
(See Appendix A for more information)

Note: AND operator is used (by default) in the search process when more than one field is included in the properties parameter.

String
clientOptional parameter for the client codeString
projectOptional parameter for the project codeString

Rest Invoke

  • http://localhost:port/GSService/xml/ or http://localhost:port/GSService/json/
  • UriTemplate:
    • “/SearchDocument/?library={library}&user={user}&password={password}&form={form}&properties={properties}&client={client}&project={project}”
    • “/SearchDocumentDST/?library={library}&user={user}&dst={dst}&form={form}&properties={properties}&client={client}&project={project}”

Example

http://localhost:8732/GSService/xml/SearchDocument/?library=DMTESTLEGAL&user=admin&password=gsolutions123&form=LAWPROF&properties=*info*

The method returns an array of integers, which are the document numbers that match the search criteria.  If the search has no results then the method returns “nil=true”.

DST Example

http://localhost:8732/GSService/xml/SearchDocumentDST/?library=DMTESTLEGAL&user=admin&dst=afd448a5d0f9b...55355b8c677ad16&form=LAWPROF&properties=*info*

Error

Detailed errors can be found in the error log. See Appendix D for more information about the edocs.log file.