Objective
Returns profile information about all the documents retrieved by the filter specified in the “searchCriteria” parameter.
It allows the user to select a number of elements in every page and retrieve only the selected page.
Parameters
| Parameter | Description | Type |
| library | eDOCS library | String |
| user | User name | String |
| password | User password | String |
| searchForm | The name of the search form. | String |
| searchCriteria | All of these properties must be passed as a string. (See Appendix A for more information) | String |
| orderByProperties | The same format as “searchCriteria” parameter. 0 forces ascending order and 1 forces descending order. It’s possible to combine ascending and descending order types like in this example: All the properties passed in orderByProperties must be included in the returnProperties field. | Long |
| retrieveAll | With “True” value all the properties in the profile are returned addition to all the properties introduced in parameter “returnProperties” if it contains any property. With “False” value only properties written in the “returnProperties” parameter are returned. | String |
| returnProperties | When the value for the “retrieveAll” parameter is “False”, it is mandatory to pass a string with the properties. If any properties have been specified in the “orderByProperties” parameter, they must also be present here. If the value for retrieveAll is “True,” this parameter can be used to include non-profile properties, such as FT_SCORE. | String |
| client | Optional parameter for the client code | String |
| project | Optional parameter for the project code | String |
| rowsLimit | The number of results to be returned. To return all possible results, this parameter should be set to 0. | String |
| showTrustees | If “True” is passed, security information is included in the XML. This value should only be set to “True” if really necessary, due to process time consumption. (See Appendix C for more information) | String |
| dbSchema | Database schema. By default is set to “DOCSADM” if an empty string is passed. | String |
| index | Number of the page. First page is 0. | Integer |
| maxRows | Number of rows to return in each page. | Integer |
Rest Invoke
- http://localhost:port/GSService/xml/ or http://localhost:port/GSService/json/
- UriTemplate:
- “/AdvancedSearchDocumentPag/?library={library}&user={user}&password={password}&searchForm={searchForm}&searchCriteria={searchCriteria}&orderByProperties={orderByProperties}&retrieveAll={retrieveAll}&returnProperties={returnProperties}&rowsLimit={rowsLimit}&showTrustees={showTrustees}&dbSchema={dbSchema}&client={client}&project={project}”
- “/AdvancedSearchDocumentPagDST/?library={library}&user={user}&dst={dst}&searchForm={searchForm}&searchCriteria={searchCriteria}&orderByProperties={orderByProperties}&retrieveAll={retrieveAll}&returnProperties={returnProperties}&rowsLimit={rowsLimit}&showTrustees={showTrustees}&dbSchema={dbSchema}&index={index}&maxRows={maxRows}&client={client}&project={project}”
Example
http://localhost:8732/GSService/xml/AdvancedSearchDocumentPag/?library=DMTESTLEGAL&user=admin&password=owc123&searchForm=LAWPROF&searchCriteria=*test* &orderByProperties=0 &retrieveAll=false&returnProperties=&rowsLimit=0&showTrustees=false&dbSchema=&index=0&maxRows=10&client=01&project=001
The method returns 0 if the delete operation is successful, or an error if the operation fails (errors are also included in the error log file).
DST Example
http://localhost:8732/GSService/xml/AdvancedSearchDocumentPagDST/?library=DMTESTLEGAL&user=admin&dst=afd448a5d0f9b89f7c9fe276...d57e8e01e953116&searchForm=lawprof&searchCriteria=*test* &orderByProperties=0 &retrieveAll=false&returnProperties=&rowsLimit=0&showTrustees=false&dbSchema=&index=0&maxRows=10&client=01&project=001
Error
Check the edocs.log file if errors arise in the unlock process.
