restoreFile

Restores a file from the archive server to another server.

Request

<archiveRequest version="2.0">
   <restoreFile> 
      <source>
         <fileName>
            <actualName/>
         </fileName>
         <archiveInfo>
            <server/>
            <volume/>
            <job>
               <jobName/>
               <fileKey/>
               <metaDataKey/>
            </job>
         </archiveInfo>
      </source>
      <destination>
         <serverIPAddress/>
         <fileName/>
         <createDirs/>
         <overwrite/>
      </destination>
   </restoreFile>
</archiveRequest>

Reply

<archiveReply version="2.0">
   <restoreFile>
      <result value=" ">
         <description/>
      </result>
   </restoreFile>
</archiveReply>

Elements

actualName: Specifies the name, in the format sent from the archive server, of the file. It's the name received from getContentVersions.
archiveInfo: (Optional) Specifies the archived information received from a previous query.
job: Specifies the job. Repeat for each job.
jobName: Specifies the name of the job as received from a directory content query or a version query.
fileKey: Specifies the file key as received from a directory content query or a version query.
fileName: Specifies the name of the file, including the volume name. Use forward slashes as separators.
createDirs: (Optional) Specifies that the destination directories should be created if they don't yet exist.
overwrite: (Optional) Specifies that the destination file should be overwritten if it exists.
result: Specifies an error value or zero (for no error).
description: Specifies a text description of the returned result.