Objective

Return a XML file containing information about all users and groups (trustees) associated with a specific document or folder and the permissions that each user and/or group has on the document. The permission list is known as ACL (Access Control List). DST must be provided.

Parameters

ParameterDescriptionType
libraryeDOCS libraryString
userUser nameString
passwordUser passwordString
docNumberListThe DocNumber of the document. It is also possible to retrieve the ACL for several documents by passing a string of DocNumbers separated by semicolon (;).

IE: “12608721;12608720”

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:
    • “/GetTrusteesList/?library={library}&user={user}&password={password}&docNumberList={docNumberList}&dbSchema={dbSchema}&client={client}&project={project}”
    • “/GetTrusteesListDST/?library={library}&user={user}&dst={dst}&docNumberList={docNumberList}&dbSchema={dbSchema}&client={client}&project={project}”

Example

http://localhost:8732/GSService/xml/GetTrusteesList/?library=DMTESTLEGAL&user=admin&password=owc123&docNumberList=747;754&dbSchema=DOCSADM

The method returns XML containing the docnumber of the document or documents searched, and a list of the users and groups with permissions on the document.

DST Example

http://localhost:8732/GSService/xml/GetTrusteesListDST/?library=DMTESTLEGAL&user=admin&dst=afd448a5d0f9b...55355b8c677ad16&docNumberList=747;754&dbSchema=DOCSADM

Error

Check the event.log file if you find errors.