Objective

Returns profile information about all the documents retrieved by the filter specified in the “searchCriteria” parameter. DST must be provided in the DST version of the method.

Parameters

ParameterDescriptionType
libraryeDOCS libraryString
userUser nameString
passwordUser passwordString
searchFormThe name of the search form.String
searchCriteriaAll of these properties must be passed as a string.

*IN*12608690

(See Appendix A for more information)

String
orderByPropertiesThe 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:
01

All the properties passed in orderByProperties must be included in the returnProperties field.

Long
retrieveAllWith “True” value all the properties in the profile are returned, plus all properties introduced in parameter “returnProperties”, if it contains any. With “False” value only properties written in the “returnProperties” parameter are returned.String
returnPropertiesIf the value for the “retrieveAll” parameter is “False”, then it is mandatory to pass a string with the properties. If any properties have been specified in the “orderByProperties” parameter then they must also be present here. If the value for retrieveAll is “True,” then this parameter can be used to include non-profile properties, such as FT_SCORE.
String
clientOptional parameter for the client codeString
projectOptional parameter for the project codeString
rowsLimitThe number of results to be returned. To return all possible results, this parameter should be set to 0.String
showTrusteesIf “True” is passed, security information is included in the XML. This value should be used carefully as it increases the work load on the server.

(See Appendix C for more information)

String
dbSchemaDatabase schema. By default is set to “DOCSADM” if an empty string is passed.String

Rest Invoke

  • http://localhost:port/GSService/xml/ or http://localhost:port/GSService/json/
  • UriTemplate:
    • “/AdvancedSearchDocument/?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}”
    • “/AdvancedSearchDocumentDST/?library={library}&user={user}&dst={dst}&searchForm={searchForm}&searchCriteria={searchCriteria}&orderByProperties={orderByProperties}&retrieveAll={retrieveAll}&returnProperties={returnProperties}&rowsLimit={rowsLimit}&showTrustees={showTrustees}&dbSchema={dbSchema}&client={client}&project={project}”

Example

http://localhost:8732/GSService/xml/AdvancedSearchDocument/?library=DMTESTLEGAL&user=admin&password=gsolutions123&searchForm=LAWPROF&searchCriteria=*TESTPDF*&orderByProperties=01&retrieveAll=False&returnProperties=&rowsLimit=0&showTrustees=True&dbSchema=DOCSADM

As shown previously, the method returns a XML file with the profile properties requested as well as information about security permissions and users and groups associated with each document.

DST Example

http://localhost:8732/GSService/xml/AdvancedSearchDocumentDST/?library=DMTESTLEGAL&user=admin&dst=afd448a5d0f9b...55355b8c677ad16&searchForm=LAWPROF&searchCriteria=*TEST*&orderByProperties=01&retrieveAll=False&returnProperties=&rowsLimit=0&showTrustees=TRUE&dbSchema=DOCSADM

Error

Check the edocs.log file if errors arise in the unlock process.