getDirContents

Request

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

Reply

<archiveReply version="2.0">
   <getDirContents>
      <dirName>
         <name/>
         <archiveInfo>
            <job>
               <jobName/>
               <fileKey/> 
            </job>
         </archiveInfo>
      </dirName>
      <startHere/> 
   </getDirContents>
   <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. If archiveInfo isn't specified, the full path is evaluated. Only component names with a current status are used when parsing the path.

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.

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, file, or unknown. If type is unknown, call getVersions to retrieve more information. The unknown designation is used only if the file status is current and there's no other duplicated name.