deleteFile

Request

<archiveRequest version="2.0">
   <deleteFile>
      <serverIPAddress/>
      <volume/>
      <fileName/>
      <archiveInfo>
         <job>
            <jobName/>
            <fileKey/>
            <metaDataKey/>
         </job>
      </archiveInfo>
   </deleteFile>
</archiveRequest>

Reply

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

Elements

serverIPAddress

Specifies the server where the original file came from.

volume

Specifies the volume where the original file came from.

fileName

(Optional) Specifies the full path of the name of the file. Separate the path with forward slashes (/), starting from the volume root. If archiveInfo isn't specified, the full path is evaluated. Component names with only a current status are used when parsing the path. If archiveInfo is specified, fileName can be omitted.

If fileName specifies a directory, all entries contained in the directory are deleted, except for subfiles and subdirectories renamed to entries. If fileName specifies a file and metaDataKey or archiveInfo isn't specified, all content versions are deleted. If fileName specifies a file and at least one metaDataKey is specified, only the content versions specified in metaDataKey are deleted.

archiveInfo

(Optional) Specifies the information returned 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.

metaDataKey

(Optional) Specifies the content version. Repeat for each target. If the target is a file, the specific content version specified by this value is deleted.

result

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

description

Specifies a text description of the returned result.