Archiving API Operations
This section describes archiving API operations.
DeleteExpiredFiles
Informs iHub that the files in ExpiredFileIds are archived and instructs iHub to delete those files.
iHub deletes the file only if the file is expired. iHub sends the ID of each expired file in the GetNextExpiredFiles response. If ExpiredFileIds contains an ID of a file that iHub did not send, iHub ignores it.
If there are no IDs of expired files in any DeleteExpiredFiles call, iHub keeps expired files in the Encyclopedia volume and sends them to the archive application at the next archive pass.
Request schema
<xsd:complexType name="DeleteExpiredFiles">
<xsd:sequence>
<xsd:element name="SessionID" type="xsd:string"/>
<xsd:element name="ExpiredFileIds"
type="typens:ArrayOfString"/>
</xsd:sequence>
</xsd:complexType>
Request elements
SessionID
The ID that iHub generates for the current archiving session.
ExpiredFileIds
The IDs of the files that were archived and can be deleted.
Response schema
<xsd:complexType name="DeleteExpiredFilesResponse"/>
<xsd:element name="DeleteExpiredFilesResponse"
type="typens:DeleteExpiredFilesResponse"/>
EndArchive
Ends an archiving session. After iHub receives the first StartArchive call, it allows 24 hours between subsequent archive requests. If iHub does not receive any archive requests within this time period, it automatically terminates the archive session.
Request schema
<xsd:complexType name="EndArchive">
<xsd:sequence>
<xsd:element name="SessionID" type="xsd:string"/>
</xsd:sequence>
</xsd:complexType>
Request elements
SessionID
The ID that iHub generates for the current archiving session.
Response schema
<xsd:complexType name="EndArchiveResponse"/>
<xsd:element name="EndArchiveResponse"
type="typens:EndArchiveResponse"/>
GetNextExpiredFiles
Retrieves information about expired files.
iHub always returns the ID, name, version, type, and location of each expired file. Use the ResultDef element to retrieve additional information.
Request schema
<xsd:complexType name="GetNextExpiredFiles">
<xsd:sequence>
<xsd:element name="SessionID" type="xsd:string"/>
<xsd:element name="ResultDef" type="typens:ArrayOfString"
minOccurs="0"/>
<xsd:element name="MaxFiles" type="xsd:long"
minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
Request elements
SessionID
The ID that iHub generates for the current archiving session.
ResultDef
Requests the following information about the expired files:
*Description
The description of the file
*PageCount
The number of pages in the file
*Size
The size of the file
*TimeStamp
The time the file was created or modified, in Coordinated Universal Time (UTC)
*VersionName
The version name of the file
*Owner
The owner of the file
*AccessType
The file’s access type, private or shared
*ACL
The access rights to the file
*DependOnFiles
Information about the files on which the file depends
MaxFiles
The maximum number of files to retrieve and return in the result set. If not specified, the value is 1. iHub can return up to 500 files.
Response schema
<xsd:complexType name="GetNextExpiredFilesResponse">
<xsd:sequence>
<xsd:element name="ExpiredFiles"
type="typens:ArrayOfFileInfo"/>
<xsd:element name="HasMore" type="xsd:boolean"/>
</xsd:sequence>
</xsd:complexType>
Response elements
ExpiredFiles
Information about the expired files.
HasMore
Indicates whether more expired files are available. If True, more expired files are available.
StartArchive
Starts an archive pass. StartArchive is the first call that the API makes after initializing. After iHub receives the command to start the archive application, iHub waits five minutes to receive the StartArchive request. If it does not receive the request, iHub ignores the command and invalidates the SessionID.
Request schema
<xsd:complexType name="StartArchive">
<xsd:sequence>
<xsd:element name="SessionID" type="xsd:string"/>
<xsd:element name="ProviderName" type="xsd:string"
minOccurs="0"/>
<xsd:element name="IncludeFolder" type="xsd:boolean"
minOccurs="0" />
</xsd:sequence>
</xsd:complexType>
Request elements
SessionID
The ID that iHub generates for the current archiving session.
ProviderName
A string identifying the archiving application.
IncludeFolder
A flag indicating whether to include subfolders.
Response schema
<xsd:complexType name="StartArchiveResponse"/>
<xsd:element name="StartArchiveResponse"
type="typens:StartArchiveResponse"/>