getVersions

Request

<archiveRequest version="2.0">
   <getVersions maxReturnEntries=" "> 
      <serverIPAddress/>
      <volume/>
      <dirName/>
      <archiveInfo>
         <job>
            <jobName/>
            <fileKey/>
         </job>
      </archiveInfo>
      <startHere/>
   </getVersions>
</archiveRequest>

Reply

<archiveReply version="2.0">
   <getVersions>
      <dirName>
         <name/>
         <status>
            <current/>
            <renamed/>
            <deleted/>
            <changeTime/>
         </status>
         <currentName/>
         <archiveInfo>
            <job>
               <jobName/>
               <fileKey/> 
            </job>
         </archiveInfo>
      </dirName>
      <startHere/> 
      <ipAddress/>
   </getVersions>
   <result value=" ">
      <description/>
   </result>
</archiveReply>

Elements

serverIPAddress

Specifies the server where the original file came from.

volume

Specifies the volume where the original file came from.

dirName

(Optional if archiveInfo is specified) Specifies the full path of the directory name to return versions for. The path should be separated by forward slashes (/), starting from the volume root. Components with only a current status are used when parsing the path. If both archiveInfo and dirName are specified, the last component name in dirName is used to get versions under the parent directory that is specified in archiveInfo. If only archiveInfo is specified, the object specified by fileKey is used to get versions.

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.

startHere

(Optional) Specifies where to start as returned from a previous query. If this element does not exist, the search starts at the beginning.

dirName

Specifies the directory element. Repeat for each entry.

name

Specifies the entry name.

status

Specifies the status of the file or directory: current, renamed, or deleted.

current

Specifies that the file or directory is current.

renamed

Specifies that the file or directory is renamed.

deleted

Specifies that the file or directory is deleted.

changeTime

(Optional) Specifies the time, in YYYYMMDDHHMMSS format, when the status is changed. Returned if the status is renamed or deleted.

currentName

Specifies the current name for the file or directory specified by dirName. This element is returned if the status is renamed. The currentName is different from the name specified by dirName.

result

Specifies an error value or zero (for no error).

description

Specifies a text description of the returned result.

Attributes

maxReturnEntries

(Optional) Specifies the maximum number of entries to return. If this attribute is not specified, the request handler decides how many entries to return.

type

Specifies the type of object: directory or file.