Objective
It allows to modify the security of a document. It deletes the current ACL (Access Control List) and applies only one trustee to the document. It can be used both for documents and folders.
Parameters
Parameter | Description | Type |
library | eDOCS library | String |
user | User name | String |
password | User password | String |
form | The name of the form used to create new folders. | String |
securityType | Defines if the new trustee is a Group or a User.
| String |
accessRights | Defines the new access level that the trustee will have on the document or folder. Only values listed in Appendix B are permitted. (See Appendix B to obtain information about the full list of allowed security values) | String |
trusteeName | The name of the User or Group. It must be valid on the library. | String |
docNumber | Document number. Only one document number is allowed. | String |
dbSchema | Database schema. By default is set to “DOCSADM” if an empty string is used. | 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:
- “/ChangeDocumentSecurity/?library={library}&user={user}&password={password}&form={form}&securityType={securityType}&accessRights={accessRights}&trusteeName={trusteeName}&docNumber={docNumber}&dbSchema={dbSchema}&client={client}&project={project}”
- “/ChangeDocumentSecurityDST/?library={library}&user={user}&dst={dst}&form={form}&securityType={securityType}&accessRights={accessRights}&trusteeName={trusteeName}&docNumber={docNumber}&dbSchema={dbSchema}&client={client}&project={project}”
Example
http://localhost:8732/GSService/xml/ChangeDocumentSecurity/?library=DMTESTLEGAL&user=admin&password=owc123&form=LAWPROF&securityType=2&accessRights=29&trusteeName=TEST1&docNumber=310&dbSchema=DOCSADM
The method returns 0 if operation is successful or -1 if the operation fails.
DST Example
http://localhost:8732/GSService/xml/ChangeDocumentSecurityDST/?library=DMTESTLEGAL&user=admin&dst=afd448a5d0f9b...55355b8c677ad16&form=LAWPROF&securityType=2&accessRights=29&trusteeName=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.