GetFileACL
Retrieves the ACL of the specified Encyclopedia file or folder.
Request schema
<xsd:complexType name="GetFileACL">
<xsd:sequence>
<xsd:choice>
<xsd:element name="FileId" type="xsd:string"/>
<xsd:element name="FileName" type="xsd:string">
</xsd:element>
</xsd:choice>
<xsd:choice minOccurs="0">
<xsd:element name="GrantedUserId" type="xsd:string"
minOccurs="0"/>
<xsd:element name="GrantedUserName" type="xsd:string"
minOccurs="0"/>
<xsd:element name="GrantedRoleId" type="xsd:string"
minOccurs="0"/>
<xsd:element name="GrantedRoleName" type="xsd:string"
minOccurs="0"/>
</xsd:choice>
<xsd:element name="FetchSize" type="xsd:int"
minOccurs="0"/>
<xsd:element name="FetchDirection" type="xsd:boolean"
minOccurs="0"/>
<xsd:element name="CountLimit" type="xsd:int"
minOccurs="0"/>
<xsd:element name="FetchHandle" type="xsd:string"
minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
Request elements
FileId
The ID of the file or folder for which to retrieve the ACL. Specific either the FileId or the FileName.
FileName
The full name of the file or folder for which to retrieve the ACL. Specify either FileName or FileId.
GrantedUserId
The user ID.
GrantedUserName
The user name.
GrantedRoleId
The role ID.
GrantedRoleName
The role name.
FetchSize
The maximum number of records to retrieve and return in a result set. The default value is 500.
FetchDirection
If True, records are retrieved forward. If False, records are retrieved backward. The default value is True.
CountLimit
The maximum number of records to count. By default, CountLimit is equal to FetchSize. To count all records, set CountLimit to ‑1.
FetchHandle
Retrieves more items from the result set. In the second and subsequent calls for data, specify the same search criteria as in the original call.
Response schema
<xsd:complexType name="GetFileACLResponse">
<xsd:sequence>
<xsd:element name="ACL"type="typens:ArrayOfPermission"
minOccurs="0"/>
<xsd:element name="FetchHandle" type="xsd:string"
minOccurs="0"/>
<xsd:element name="TotalCount" type="xsd:int" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
Response elements
ACL
The ACL of the file or folder.
FetchHandle
Indicates that the number of items in the result set exceeds the FetchSize limit.
TotalCount
The number of entries in the search result set.