DeleteFile
Deletes files or folders. To delete a single file or folder, specify Name or Id. To delete several files or folders, specify NameList or IdList. To delete files or folders that match the specified conditions, specify Search.
Request schema
<xsd:complexType name="DeleteFile">
<xsd:sequence>
<xsd:choice minOccurs="0">
<xsd:element name="WorkingFolderId" type="xsd:string"/>
<xsd:element name="WorkingFolderName" type="xsd:string"/>
</xsd:choice>
<xsd:element name="Recursive" type="xsd:boolean"
minOccurs="0"/>
<xsd:element name="LatestVersionOnly" type="xsd:boolean" minOccurs="0"/>
<xsd:choice>
<xsd:element name="Search" type="typens:FileSearch"/>
<xsd:element name="IdList" type="typens:ArrayOfString">
<xsd:element name="NameList"
type="typens:ArrayOfString"/>
<xsd:element name="Id" type="xsd:string"/>
<xsd:element name="Name" type="xsd:string"/>
</xsd:choice>
<xsd:element name="IgnoreMissing" type="xsd:boolean"
minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
Request elements
WorkingFolderId
The ID of the working folder of the file or folder to delete. Specify either WorkingFolderId or WorkingFolderName.
WorkingFolderName
The name of the working folder of the file or folder to delete. Specify either WorkingFolderName or WorkingFolderId.
Recursive
Specifies whether to delete subfolders. If True, subfolders are deleted. If False, only the specified folder is deleted. The default value is False.
LatestVersionOnly
Specifies whether to delete only the latest version of the file. If True, only the latest version of the file is deleted. The default value is False.
Search
The search condition that specifies which folders or files to delete.
IdList
The list of file or folder IDs to delete. Specify either IdList or NameList.
NameList
The list of file or folder names to delete. Specify either NameList or IdList.
Id
The ID of the single file or folder to delete. Specify either Id or Name.
Name
The name of the single file or folder to delete. Specify either Name or Id.
IgnoreMissing
Specifies what to do if the specified file or folder does not exist. If True, BIRT iHub ignores the request. If False, the operation reports an error and stops. The default value is True.