Objective

It allows to modify the security of a document. It deletes the current ACL (Access Control List) and applies a new ACL list which can include different users, groups and access rights. It can be used both for documents and folders.

Parameters

ParameterDescriptionType
libraryeDOCS libraryString
userUser nameString
passwordUser passwordString
formThe name of the form used to create new folders.String
aclThe new Access Control List. The format is:

securityTypeA,accessRightsA,trusteeNameA;… ; securityTypeN,accessRightsN,trusteeNameN

String
docNumberDocument number. Only one document number is allowed.String
dbSchemaDatabase schema. By default is set to “DOCSADM” if an empty string is passed.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:
    • “/ChangeDocumentSecurityAdvanced/?library={library}&user={user}&password={password}&form={form}&acl={acl}&docNumber={docNumber}&dbSchema={dbSchema}&client={client}&project={project}”
    • “/ChangeDocumentSecurityAdvancedDST/?library={library}&user={user}&dst={dst}&form={form}&acl={acl}&docNumber={docNumber}&dbSchema={dbSchema}&client={client}&project={project}”

Example

http://localhost:8732/GSService/xml/ChangeDocumentSecurityAdvanced/library=DMTESTLEGAL&user=admin&password=owc123&form=LAWPROF&acl=2,29,TEST1&docNumber=310&dbSchema=DOCSADM

The method returns 0 if operation is successful or -1 if the operation fail.

DST Example

http://localhost:8732/GSService/xml/ChangeDocumentSecurityAdvancedDST/?library=DMTESTLEGAL&user=admin&dst=afd448a5d0f9b...55355b8c677ad16&form=LAWPROF&acl=2,29,TEST1&docNumber=310&dbSchema=DOCSADM

Error

As this method returns an integer, detailed errors can be found in the error log. See Appendix D  for more information about the edocs.log file.