Retrieving autoarchive rules for a file or folder
Use GetFileDetails to retrieve the autoarchive rules for a file or folder. Identify the file, then specify ArchiveRules as a string in ResultDef, as shown in the following example:
<SOAP-ENV:Body>
<GetFileDetails>
<FileId>4</FileId>
<ResultDef>
<String>ArchiveRules</String>
</ResultDef>
</GetFileDetails>
</SOAP-ENV:Body>
The response returns identifying information about the file, followed by the autoarchive rules for the file and the folder that contains it. In the following example, the file type $$$ indicates that the rule applies to a folder. The expiration age is in minutes.
<SOAP-ENV:Body>
<GetFileDetailsResponse>
<File>
<Id>4</Id>
<Name>/Inventory/pie.rptdesign</Name>
<FileType>RPTDESIGN</FileType>
<TimeStamp>2008-12-11T22:12:17</TimeStamp>
<Owner>Administrator</Owner>
<UserPermissions>VSRWEDG</UserPermissions>
<Version>1</Version>
<PageCount>12</PageCount>
<Size>74240</Size>
</File>
<ArchiveRules>
<ArchiveRule>
<FileType>RPTDESIGN</FileType>
<NeverExpire>false</NeverExpire>
<ExpirationAge>23040</ExpirationAge>
<ExpireDependentFiles>false</ExpireDependentFiles>
<ArchiveOnExpiration>true</ArchiveOnExpiration>
<IsInherited>false</IsInherited>
</ArchiveRule>
<ArchiveRule>
<FileType>$$$</FileType>
<NeverExpire>false</NeverExpire>
<ExpirationAge>23040</ExpirationAge> <ExpireDependentFiles>false</ExpireDependentFiles>
<ArchiveOnExpiration>true</ArchiveOnExpiration>
<IsInherited>true</IsInherited>
<InheritedFrom>/Inventory</InheritedFrom>
</ArchiveRule>
</ArchiveRules>
</GetFileDetailsResponse>
</SOAP-ENV:Body>