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
| Parameter | Description | Type |
| library | eDOCS library | String |
| user | User name | String |
| password | User password | String |
| form | The name of the form. | String |
| properties | All of the properties must be passed as a string. To get all documents named “eDOCS IS”: Wildcards as “*” are allowed and the search is case insensitive. Note: AND operator is used (by default) in the search process when more than one field is included in the properties parameter. | String |
| client | Optional parameter for the client code | String |
| project | Optional parameter for the project code | String |
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.
